Skip to content

Commit

Permalink
Puts simpleion front-and-center in the README.
Browse files Browse the repository at this point in the history
Fixes: #78
  • Loading branch information
tgregg committed Apr 15, 2019
1 parent 89f0f6d commit 02afe3f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,23 @@ for Python.

This package is designed to work with **Python 2.6+** and **Python 3.3+**

## Getting Started

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.

For example:

```
>>> import amazon.ion.simpleion as ion
>>> obj = ion.loads('{abc: 123}')
>>> obj['abc']
123
>>> ion.dumps(obj, binary=False)
'$ion_1_0 {abc:123}'
```

## Git Setup
This repository contains a [git submodule](https://git-scm.com/docs/git-submodule)
called `ion-tests`, which holds test data used by `ion-python`'s unit tests.
Expand Down

0 comments on commit 02afe3f

Please sign in to comment.