Fork

Author: mxstbr

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Atsushi NAGASE
+Copyright (c) 2017 Space Program Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,8 @@
-draft-js-markdown-shortcuts-plugin
+draft-js-markdown-plugin
 ==================================
 
-[![CircleCI](https://circleci.com/gh/ngs/draft-js-markdown-shortcuts-plugin.svg?style=svg)](https://circleci.com/gh/ngs/draft-js-markdown-shortcuts-plugin)
-[![npm](https://img.shields.io/npm/v/draft-js-markdown-shortcuts-plugin.svg)][npm]
-[![Coverage Status](https://coveralls.io/repos/github/ngs/draft-js-markdown-shortcuts-plugin/badge.svg?branch=master)](https://coveralls.io/github/ngs/draft-js-markdown-shortcuts-plugin?branch=master)
+[![npm](https://img.shields.io/npm/v/draft-js-markdown-plugin.svg)][npm]
+<!-- [![Coverage Status](https://coveralls.io/repos/github/withspectrum/draft-js-markdown-plugin/badge.svg?branch=master)](https://coveralls.io/github/withspectrum/draft-js-markdown-plugin?branch=master) -->
 
 A [DraftJS] plugin for supporting Markdown syntax shortcuts
 
@@ -13,36 +12,31 @@ This plugin works with [DraftJS Plugins] wrapper component.
 
 [View Demo][Demo]
 
-Usage
------
+## Usage
 
 ```sh
-npm i --save draft-js-markdown-shortcuts-plugin
+npm i --save draft-js-markdown-plugin
 ```
 
 then import from your editor component
 
 ```js
-import createMarkdownShortcutsPlugin from 'draft-js-markdown-shortcuts-plugin';
+import createMarkdownPlugin from 'draft-js-markdown-plugin';
 ```
 
-Example
--------
+### Full Example
 
 ```js
 import React, { Component } from 'react';
 import Editor from 'draft-js-plugins-editor';
-import createMarkdownShortcutsPlugin from 'draft-js-markdown-shortcuts-plugin';
+import createMarkdownPlugin from 'draft-js-markdown-plugin';
 import { EditorState } from 'draft-js';
 
-const plugins = [
-  createMarkdownShortcutsPlugin()
-];
-
 export default class DemoEditor extends Component {
 
   state = {
     editorState: EditorState.createEmpty(),
+    plugins: [createMarkdownPlugin()]
   };
 
   onChange = (editorState) => {
@@ -56,20 +50,25 @@ export default class DemoEditor extends Component {
       <Editor
         editorState={this.state.editorState}
         onChange={this.onChange}
-        plugins={plugins}
+        plugins={this.state.plugins}
       />
     );
   }
 }
 ```
 
-License
--------
+## License
+
+Licensed under the MIT license, Copyright Ⓒ 2017 Space Program Inc. This plugin is forked from the excellent [`draft-js-markdown-shortcuts-plugin`](https://github.com/ngs/draft-js-markdown-shortcuts-plugin) by [Atsushi Nagase](https://github.com/ngs).
+
+See [LICENSE] for the full license text.
+
+## Why fork the `markdown-shortcuts-plugin`?
 
-MIT. See [LICENSE]
+Writing is a core part of our app, and while the `markdown-shortcuts-plugin` is awesome and battle-tested there are a few opinionated things we wanted to do differently. Rather than bother [@ngs](https://github.com/ngs) with tons of PRs, we figured it'd be better to own that core part of our experience fully. 
 
-[Demo]: https://ngs.github.io/draft-js-markdown-shortcuts-plugin
+[Demo]: https://ngs.github.io/draft-js-markdown-plugin
 [DraftJS]: https://facebook.github.io/draft-js/
 [DraftJS Plugins]: https://github.com/draft-js-plugins/draft-js-plugins
 [LICENSE]: ./LICENSE
-[npm]: https://www.npmjs.com/package/draft-js-markdown-shortcuts-plugin
+[npm]: https://www.npmjs.com/package/draft-js-markdown-plugin

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "draft-js-markdown-shortcuts-plugin",
-  "version": "0.3.0",
-  "description": "A DraftJS plugin for supporting Markdown syntax shortcuts",
+  "name": "draft-js-markdown-plugin",
+  "version": "0.0.1",
+  "description": "A DraftJS plugin for supporting Markdown syntax shortcuts, fork of draft-js-markdown-shortcuts-plugin",
   "main": "lib/index.js",
   "scripts": {
     "eslint": "node_modules/.bin/eslint .",
@@ -28,20 +28,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ngs/draft-js-markdown-shortcuts-plugin.git"
+    "url": "git+https://github.com/withspectrum/draft-js-markdown-plugin.git"
   },
   "keywords": [
     "draftjs",
     "editor",
     "plugin",
     "markdown"
   ],
-  "author": "Atsushi Nagase",
+  "author": "Max Stoiber <contact@mxstbr.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/ngs/draft-js-markdown-shortcuts-plugin/issues"
+    "url": "https://github.com/withspectrum/draft-js-markdown-plugin/issues"
   },
-  "homepage": "https://github.com/ngs/draft-js-markdown-shortcuts-plugin#readme",
+  "homepage": "https://github.com/withspectrum/draft-js-markdown-plugin#readme",
   "devDependencies": {
     "autoprefixer": "^6.5.3",
     "babel-cli": "^6.18.0",