diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42aab4f..a3360bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,9 +34,10 @@ Here we go! ๐Ÿค  First, clone this repository: ```bash git clone https://github.com/Ionaru/easy-markdown-editor.git +cd easy-markdown-editor ``` -Then install the EasyMDE for development environment with npm: +Then install the EasyMDE with npm: ```bash npm install @@ -44,6 +45,7 @@ npm install Yay! You are ready! ๐Ÿพ + ### โคด๏ธ Creating a pull request 1. First, [create a fork of this project](https://github.com/Ionaru/easy-markdown-editor/fork), and copy the https URL (*clone or download* button) of your project (something like https://github.com/YOUR_USERNAME/easy-markdown-editor.git ); @@ -56,6 +58,6 @@ Yay! You are ready! ๐Ÿพ 6. push it to a dedicated branch `git push origin myMergeRequest`; 7. got to the [main project page](https://github.com/Ionaru/easy-markdown-editor) and click on the button *Compare and pull request*, then fill the description. -If you want to make other pull requests, go back to the development branch (`git checkout development`), update it (`git pull --rebase source development`), then follow the instructions above from step 3. +If you want to make other pull requests, go back to the master branch (`git checkout master`), update it (`git pull --rebase source master`), then follow the instructions above from step 3. Thank you! ๐Ÿ’œ diff --git a/README.md b/README.md index e7e42b9..2d9ee31 100644 --- a/README.md +++ b/README.md @@ -417,6 +417,16 @@ Changes include: My intention is to continue development on this project, improving it and keeping it alive. +## Hacking EasyMDE + +You may want to edit this library to adapt its behavior to your needs. This can be done in some quick steps: + +1. Follow the [prerequisites](./CONTRIBUTING.md#prerequisites) and [installation](./CONTRIBUTING.md#installation) instructions in the contribution guide; +2. Do your changes; +3. Run `gulp` command, which will generate files: `dist/easymde.min.css` and `dist/easymde.min.js`; +4. Copy-paste those files to your code base, and you are done. + + ## Contributing Want to contribute to EasyMDE? Thank you! We have a [contribution guide](./CONTRIBUTING.md) just for you!