diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..cb8fcddbe --- /dev/null +++ b/README.rst @@ -0,0 +1,108 @@ +django-xadmin |Build Status| +============================ + +.. |Build Status| image:: https://travis-ci.org/sshwsfc/django-xadmin.png?branch=master + :target: https://travis-ci.org/sshwsfc/django-xadmin + +Drop-in replacement of Django admin comes with lots of goodies, fully extensible with plugin support, pretty UI based on Twitter Bootstrap. + +Live Demo +--------- + +http://demo.xadmin.io + +- User: admin +- Password: admin + +Features +-------- + +- Drop-in replacement of Django admin +- Twitter Bootstrap based UI with theme support +- Extensible with plugin support +- Better filter, date range, number range, etc. +- Built-in data export with xls, csv, xml and json format +- Dashboard page with widget support +- In-site bookmarking +- Full CRUD methods + +Screenshots +----------- + +.. figure:: https://raw.github.com/sshwsfc/django-xadmin/docs-chinese/docs/images/plugins/action.png + :alt: Actions + +.. figure:: https://raw.github.com/sshwsfc/django-xadmin/docs-chinese/docs/images/plugins/filter.png + :alt: Filter + +.. figure:: https://raw.github.com/sshwsfc/django-xadmin/docs-chinese/docs/images/plugins/chart.png + :alt: Chart + +.. figure:: https://raw.github.com/sshwsfc/django-xadmin/docs-chinese/docs/images/plugins/export.png + :alt: Export Data + +.. figure:: https://raw.github.com/sshwsfc/django-xadmin/docs-chinese/docs/images/plugins/editable.png + :alt: Edit inline + +Get Started +----------- + +**Install** + +Xadmin is best installed via PyPI. To install the latest version, run: + +.. code:: bash + + pip install django-xadmin + +or Install from github source: + +.. code:: bash + + pip install git+git://github.com/sshwsfc/django-xadmin.git + +Install Requires +---------------- + +- `django`_ >=1.4 + +- `django-crispy-forms`_ >=1.2.3 (For xadmin crispy forms) + +- `django-reversion`_ (For object history and reversion feature, please select right version by your django, see `changelog`_ ) + +- `xlwt`_ (For export xls files, option) + +.. _django: http://djangoproject.com +.. _django-crispy-forms: http://django-crispy-forms.rtfd.org +.. _django-reversion: https://github.com/etianen/django-reversion +.. _changelog: https://github.com/etianen/django-reversion/blob/master/CHANGELOG.markdown +.. _xlwt: http://www.python-excel.org/ + +Documentation +------------- + +- English (coming soon) +- `Chinese`_ + +.. _Chinese: https://xadmin.readthedocs.org/en/latest/index.html + +Online Group +------------ + +- QQ群 : 282936295 + +Run Demo Locally +---------------- + +.. code:: bash + + cd demo_app + ./manage.py runserver + +Open http://127.0.0.1:8000 in your browser, the admin user password is ``admin`` + +Help +---- + +Help Translate : http://trans.xadmin.io + diff --git a/setup.py b/setup.py index b4c2601a3..baf905020 100644 --- a/setup.py +++ b/setup.py @@ -8,11 +8,11 @@ name='django-xadmin', version='0.1.12-dev', description='Drop-in replacement of Django admin comes with lots of goodies, fully extensible with plugin support, pretty UI based on Twitter Bootstrap.', - long_description=open('README.md').read(), + long_description=open('README.rst').read(), author='sshwsfc', author_email='sshwsfc@gmail.com', url='http://www.xadmin.io', - download_url='http://github.com/sshwsfc/django-xadmin/archive/master.zip', + download_url='http://github.com/sshwsfc/django-xadmin/archive/0.1.12.dev.zip', packages=['xadmin', 'xadmin.plugins', 'xadmin.templatetags', 'xadmin.views'], include_package_data=True, install_requires=[