diff --git a/README.rst b/README.rst index 507a4f0c..dc32f115 100644 --- a/README.rst +++ b/README.rst @@ -14,14 +14,14 @@ Additionaly, Jedi suports two different goto functions and has support for renaming as well as Pydoc support and some other IDE features. Jedi uses a very simple API to connect with IDE's. There's a reference -implementation as a `VIM-Plugin `_, +implementation as a `VIM-Plugin `_, which uses Jedi's autocompletion. I encourage you to use Jedi in your IDEs. It's really easy. If there are any problems (also with licensing), just contact me. Jedi can be used with the following plugins/software: -- `VIM-Plugin `_ +- `VIM-Plugin `_ - `Emacs-Plugin `_ - `Sublime-Plugin `_ - `wdb (web debugger) `_ @@ -43,7 +43,7 @@ Pydoc support (with highlighting, Shift+k). There is also support for goto and renaming. -Get the latest version from `github `_ +Get the latest version from `github `_ (master branch should always be kind of stable/working). Docs are available at `https://jedi.readthedocs.org/ @@ -52,6 +52,7 @@ and/or fixes are awesome and most welcome. Jedi uses `semantic versioning `_. + Installation ============ @@ -65,8 +66,12 @@ corresponding documentation. Feature Support and Caveats =========================== -Jedi really understands your Python code, for a comprehensive list what Jedi -understands, see: https://jedi.readthedocs.org/en/latest/docs/features.html. +Jedi really understands your Python code. For a comprehensive list what Jedi can +do, see: https://jedi.readthedocs.org/en/latest/docs/features.html. A list of +caveats can be found on the same page. + +Tips on how to use Jedi efficiently can be found here: +https://jedi.readthedocs.org/en/latest/docs/recipes.html A little history