Skip to content

Commit 3878844

Browse files
committed
Updated installation instructions for new namespace packages
1 parent 4be61b8 commit 3878844

1 file changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,33 @@ you're a tool author you may be interested in the formal [EBNF grammar][].
3333
Installation
3434
------------
3535

36-
pip install fluent
36+
python-fluent consists of two namepsace packages:
37+
38+
* `fluent.syntax` - includes AST classes and parser. Most end users will not
39+
need this directly. Documentation coming soon!
40+
41+
To install:
42+
43+
pip install fluent.syntax
44+
45+
46+
* `fluent.bundle` - methods for generating translations from FTL files.
47+
Documentation below.
48+
49+
To install:
50+
51+
pip install fluent.bundle
52+
53+
(The correct version of ``fluent.syntax`` will be installed automatically)
54+
55+
56+
PyPI also contains an old `fluent` package which is an older version of just
57+
`fluent.syntax`.
3758

3859
Usage
3960
-----
4061

41-
To generate translations from this Python libary, you start with the
62+
To generate translations using ``fluent.bundle``, you start with the
4263
`FluentBundle` class:
4364

4465
>>> from fluent.bundle import FluentBundle

0 commit comments

Comments
 (0)