Skip to content

Commit 1ced218

Browse files
authored
Merge pull request #76 from allthatilk/master
Improve clarity of README
2 parents d95823b + 7a9b905 commit 1ced218

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ martor |pypi version|
1717
.. image:: https://travis-ci.org/agusmakmun/django-markdown-editor.svg?branch=master
1818
:target: https://travis-ci.org/agusmakmun/django-markdown-editor
1919

20-
**Martor** is Markdown Editor plugin for Django and new face of **DracEditor**.
20+
**Martor** is a Markdown Editor plugin for Django and the new face of **DracEditor**.
2121

2222

2323
Features
@@ -26,13 +26,13 @@ Features
2626
* Live Preview
2727
* Integrated with `Ace Editor`_
2828
* Integrated with `Semantic-UI`_
29-
* Support Multiple Fields (`fixed this issue`_)
30-
* Upload Image to imgur.com `(via API)` and `custom uploader`_.
31-
* Direct Mention users ``@[username]`` - `(require user to logged in)`
32-
* Support embed/iframe video from (Youtube, Vimeo, Dailymotion, Yahoo, Veoh, & Metacafe)
29+
* Supports Multiple Fields (`fixed this issue`_)
30+
* Upload Images to imgur.com `(via API)` and `custom uploader`_.
31+
* Direct Mention users ``@[username]`` - `(requires user to logged in)`
32+
* Supports embed/iframe video from (Youtube, Vimeo, Dailymotion, Yahoo, Veoh, & Metacafe)
3333
* Emoji ``:emoji_name:`` + Cheat sheets
34-
* Martor Commands Refference
35-
* Support Django Admin
34+
* Martor Commands Reference
35+
* Supports Django Admin
3636
* Toolbar Buttons
3737
* Highlight ``pre``
3838

@@ -94,7 +94,7 @@ Martor is available directly from `PyPI`_:
9494
]
9595

9696

97-
4. Collect included some martor static files to your ``STATIC_ROOT`` folder.
97+
4. Collect martor's static files in your ``STATIC_ROOT`` folder.
9898

9999
::
100100

@@ -104,7 +104,7 @@ Martor is available directly from `PyPI`_:
104104
Setting Configurations ``settings.py``
105105
---------------------------------------
106106

107-
Please register application in https://api.imgur.com/oauth2/addclient
107+
Please register your application at https://api.imgur.com/oauth2/addclient
108108
to get ``IMGUR_CLIENT_ID`` and ``IMGUR_API_KEY``.
109109

110110
::
@@ -212,7 +212,7 @@ Usage
212212

213213
**Template**
214214

215-
Simply safe the markdown content as html ouput with loading the templatetags from ``martor/templatetags/martortags.py``.
215+
Simply safely parse markdown content as html ouput by loading templatetags from ``martor/templatetags/martortags.py``.
216216

217217
::
218218

@@ -227,12 +227,12 @@ Custom Uploader
227227
-----------------
228228

229229
If you want to save the images uploaded to your storage,
230-
**Martor** also provide to handle it. Please checkout this `WIKI`_.
230+
**Martor** also provides a way to handle this. Please checkout this `WIKI`_.
231231

232-
Test the Martor from this Repository
232+
Test Martor from this Repository
233233
-------------------------------------
234234

235-
I assume you already setup with virtual enviroment (virtualenv).
235+
Assuming you are already setup with a virtual enviroment (virtualenv):
236236

237237
::
238238

@@ -243,10 +243,10 @@ I assume you already setup with virtual enviroment (virtualenv).
243243
$ python manage.py runserver
244244

245245

246-
And let checkout at http://127.0.0.1:8000/simple-form/ to your browser.
246+
Checkout at http://127.0.0.1:8000/simple-form/ on your browser.
247247

248248

249-
Martor Commands Refference
249+
Martor Commands Reference
250250
--------------------------------
251251

252252
.. image:: https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/master/__screenshot/martor-guide.png
@@ -255,7 +255,7 @@ Martor Commands Refference
255255
Notes
256256
--------------------------------
257257

258-
**Martor** was inspired by great `django-markdownx`_, `Python Markdown`_ and `Online reStructuredText editor`_.
258+
**Martor** was inspired by these great projects: `django-markdownx`_, `Python Markdown`_ and `Online reStructuredText editor`_.
259259

260260

261261
.. _Ace Editor: https://ace.c9.io

0 commit comments

Comments
 (0)