Skip to content

Commit

Permalink
Adds an installation guide in readme (#195)
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-butler committed Mar 24, 2022
1 parent e542b1d commit 77ed296
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ This package is designed to work with **Python 3.6+**

## Getting Started

Install using pip with the following command.

```shell
python3 -m pip install amazon.ion
```


Start with the [simpleion](https://ion-python.readthedocs.io/en/latest/amazon.ion.html#module-amazon.ion.simpleion)
module, which provides four APIs (`dump`, `dumps`, `load`, `loads`) that will be familiar to users of Python's
built-in JSON parsing module. Simpleion module's performance is improved by an optional [C extension](https://github.com/amzn/ion-python/blob/master/C_EXTENSION.md).
Expand Down

0 comments on commit 77ed296

Please sign in to comment.