diff --git a/README.md b/README.md deleted file mode 100644 index 23d1fffc..00000000 --- a/README.md +++ /dev/null @@ -1,29 +0,0 @@ -SayIt -===== - -A Django application or project to store transcripts -and present them in a modern, searchable format. - -An example of SayIt in action is our website -[sayit.mysociety.org](http://sayit.mysociety.org) which contains a variety of -transcripts, including: - -* [the Leveson inquiry](http://leveson.sayit.mysociety.org) -* [the Charles Taylor trial](http://charles-taylor.sayit.mysociety.org) -* [the Plays of Shakespeare](http://shakespeare.sayit.mysociety.org) - -SayIt is a [Poplus component](http://poplus.org) -by [mySociety](http://www.mysociety.org/) - -Get involved ------------- - -If you have transcripts you'd like to be included on our website, or have -the technical skills to create such transcripts, please see -[http://sayit.mysociety.org/about/community](http://sayit.mysociety.org/about/community). - -For more information on how to use SayIt in your own Django project or as a -standalone site, please see our documentation site at -[http://mysociety.github.io/sayit/](http://mysociety.github.io/sayit/). - -[![Build Status](https://travis-ci.org/mysociety/sayit.png)](https://travis-ci.org/mysociety/sayit) diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..493a7f14 --- /dev/null +++ b/README.rst @@ -0,0 +1,31 @@ +SayIt +===== + +SayIt is an open source Django application or project to store transcripts +and present them in a modern, searchable format. + +An example of SayIt in action is mySociety's website +`sayit.mysociety.org `_ which contains a variety +of transcripts, including: + +* `The Leveson Inquiry `_ +* `The Charles Taylor trial `_ +* `The plays of Shakespeare `_ + +SayIt is a `Poplus component `_ +by `mySociety `_. + +Get involved +------------ + +If you have transcripts you'd like to be included on our website, or have +the technical skills to create such transcripts, please see +http://sayit.mysociety.org/about/community. + +For more information on how to use SayIt in your own Django project or as a +standalone site, please see our documentation site at +http://mysociety.github.io/sayit/. + +.. image:: https://travis-ci.org/mysociety/sayit.png + :alt: Build Status + :target: https://travis-ci.org/mysociety/sayit diff --git a/setup.py b/setup.py index 360f8f8e..a81e6166 100644 --- a/setup.py +++ b/setup.py @@ -15,16 +15,23 @@ def install_requires(): setup( name="django-sayit", - version='0.1', - description='A data store for speeches.', - long_description=read_file('README.md'), + version='1.0.0', + description='A data store for speeches and transcripts to make them searchable and pretty.', + long_description=read_file('README.rst'), author='mySociety', - author_email='matthew@mysociety.org', + author_email='sayit@mysociety.org', url='https://github.com/mysociety/sayit', - packages=find_packages(), + packages=find_packages(exclude=('example_project', 'example_project.*')), include_package_data=True, install_requires=install_requires(), classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Web Environment', 'Framework :: Django', + 'License :: OSI Approved :: GNU Affero General Public License v3', + 'Intended Audience :: Developers', + 'Programming Language :: Python', + 'Topic :: Database :: Front-Ends', + 'Topic :: Internet :: WWW/HTTP', ], )