Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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/).

Project details


Release history Release notifications

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 Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page