Skip to content

Commit dcb1a38

Browse files
authored
Update README.md. (#99)
1 parent 361a496 commit dcb1a38

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

Diff for: README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,26 @@
33
This is a package with preferences and syntax highlighter for cutting edge
44
Python 3, although Python 2 is well supported, too. The syntax is compatible
55
with [Sublime Text](http://www.sublimetext.com), [Atom](http://atom.io) and
6-
[Visual Studio Code](http://code.visualstudio.com).
7-
It is meant to be a drop-in replacement for the default Python package.
6+
[Visual Studio Code](http://code.visualstudio.com). It is meant to be a drop-in
7+
replacement for the default Python package.
88

9-
MagicPython correctly highlights all Python 3.5 and 3.6 syntax features,
10-
including type annotations, f-strings and regular expressions. It is built
11-
from scratch for robustness with an extensive test suite.
9+
We are proud to say that MagicPython is used by GitHub to highlight Python.
1210

13-
We are proud to say that MagicPython has been included into the
14-
[github/linguist](https://github.com/github/linguist), a library used
15-
by GitHub.com to process languages.
11+
**Attention VSCode users**: MagicPython is used as the _default_
12+
Python highlighter in Visual Studio Code. Don't install it unless you
13+
want or need the cutting edge version of it. You will likely see no
14+
difference because you're already using MagicPython.
1615

16+
MagicPython correctly highlights all Python 3 syntax features,
17+
including type annotations, f-strings and regular expressions. It is
18+
built from scratch for robustness with an extensive test suite.
1719

18-
![](https://magicstack.github.io/MagicPython/example.png)
19-
20-
Type hints in comments require support by the color scheme. The one
20+
Type hints in comments require support by the color scheme. The one
2121
used in the screenshot is
2222
[Chromodynamics](https://github.com/MagicStack/Chromodynamics).
2323

24+
![](https://magicstack.github.io/MagicPython/example.png)
25+
2426

2527
## Installation Instructions
2628

0 commit comments

Comments
 (0)