Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A script to create a readme GitHub Page for your project.

Project Description

# Readme Page

A script to create a readme [GitHub Page](https://help.github.com/articles/creating-project-pages-manually) for your project. See an [example](http://fernandojunior.github.io/readme-page).

This project uses [BeautifulSoup](http://www.crummy.com/software/BeautifulSoup/), [mkdocs](http://mkdocs.github.io/mkdocs-bootstrap/) and [six](https://pythonhosted.org/six/).

## Installation & Usage

  1. Run pip install readme-page to install the script.
  2. Run readme-page to create your repository GitHub Page.
  3. Checkout the repository page at http://<your_github_username>.github.io/<repository_name>

## Contributing

See [CONTRIBUTING](https://github.com/fernandojunior/readme-page/CONTRIBUTING.md).

## License

[![CC0](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

The MIT License.

Copyright (c) 2016 [Fernando Felix do Nascimento Junior](https://github.com/fernandojunior/).

Release History

This version
History Node

1.0.0

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
readme_page-1.0.0-py2.py3-none-any.whl
(5.3 kB) Copy SHA256 Hash SHA256
Wheel py2.py3 Mar 25, 2016
readme-page-1.0.0.tar.gz
(3.9 kB) Copy SHA256 Hash SHA256
Source None Mar 25, 2016

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting