release instructions
-fastavro
-========
+# fastavro
[![Build Status](https://travis-ci.org/tebeka/fastavro.svg?branch=master)](https://travis-ci.org/tebeka/fastavro)
**If you're interested in maintaining this package - please drop me a line**
@@ -29,11 +28,9 @@ If the optional C extension (generated by [Cython][cython]) is available, then
[Cython]: http://cython.org/
-Usage
-=====
+# Usage
-Reading
--------
+## Reading
```python
@@ -74,8 +71,7 @@ with open('weather.avro', 'rb') as fo:
process_record(record)
```
-Writing
--------
+## Writing
```python
from fastavro import writer
@@ -133,8 +129,7 @@ Here's the full command line help
--version show program's version number and exit
-p, --pretty pretty print json
-Installing
-==========
+# Installing
`fastavro` is available both on [PyPi](http://pypi.python.org/pypi)
pip install fastavro
@@ -143,8 +138,7 @@ and on [conda-forge](https://conda-forge.github.io) `conda` channel.
conda install -c conda-forge fastavro
-Hacking
-=======
+# Hacking
As recommended by Cython, the C files output is distributed. This has the
advantage that the end user does not need to have Cython installed. However it
@@ -156,15 +150,34 @@ of them. For `./test-install.sh` you'll need [virtualenv][venv].
[venv]: http://pypi.python.org/pypi/virtualenv
+### Releasing
-Changes
-=======
+We release both to [pypi][pypi] and to [conda-forge][conda-forge].
+
+We assume you have [twine][twine] installed and that you've created your own
+fork of [fastavro-feedstock][feedstock].
+
+* Make sure the tests pass
+* Run `make publish`
+* Note the sha signature emitted at the above
+* Switch to feedstock directory and edit `recipe/meta.yaml`
+ - Update `version` and `sha256` variables at the top of the file
+ - Run `python recipe/test_recipe.py`
+ - Submit a [PR][pr]
+
+[conda-forge]: https://conda-forge.org/
+[feedstock]: https://github.com/conda-forge/fastavro-feedstock
+[pr]: https://conda-forge.org/#update_recipe
+[pypi]: https://pypi.python.org/pypi
+[twine]: https://pypi.python.org/pypi/twine
+
+
+# Changes
See the [ChangeLog]
[ChangeLog]: https://github.com/tebeka/fastavro/blob/master/ChangeLog
-Contact
-=======
+# Contact
[Project Home](https://github.com/tebeka/fastavro)
