Update installation instructions (#16)

executablebooks · Feb 13, 2020 · fd18b17 · fd18b17
1 parent 58ad837
commit fd18b17
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,5 +1,5 @@
+version: 2
 name: Myst Parser
-type: sphinx
 
 python:
   version: 3

diff --git a/README.md b/README.md
@@ -8,13 +8,13 @@ An extended commonmark compliant parser, with bridges to docutils & sphinx.
 
 ## Usage
 
-This parser currently requires the [ExecutableBookProject/mistletoe](https://github.com/ExecutableBookProject/mistletoe)
-fork of mistletoe (and the myst branch).
-
 ```console
-pip install git+https://github.com/ExecutableBookProject/mistletoe.git@myst
+pip install -e git+https://github.com/ExecutableBookProject/myst_parser.git#egg=myst_parser[sphinx,code_style,testing]
 ```
 
+Note, this parser currently requires the [ExecutableBookProject/mistletoe](https://github.com/ExecutableBookProject/mistletoe)
+fork of mistletoe (included in the above installation).
+
 To use the Myst parser in sphinx, simply add: `extensions = ["myst_parser"]` to your `conf.py`.
 
 ## Parsed Token Classes