Metadata-Version: 2.1
Name: readme-md
Version: 0.0.2
Summary: README.md generate
Home-page: https://github.com/looking-for-a-job/readme-md.py
License: UNKNOWN
Description: [![](https://img.shields.io/pypi/pyversions/readme-md.svg?longCache=True)](https://pypi.org/pypi/readme-md/)
        
        ### Install
        ```bash
        $ [sudo] pip install readme-md
        ```
        
        ### Features
        +   static (`section.md`) and dynamic (python attr) sections
        +   auto headers (if not exists)
        +   customizable - settings, subclasses
        +   pre-defined sections: `badges`, `description` `requirements`, `install`, `features`, `usage`, `how`, `config`, `examples`, `todo`
        
        ### Usage
        ```bash
        usage: python -m readme_md
        ```
        
        ### Examples
        ```bash
        # default README
        $ cd path/to/repo
        $ python -m readme_md > README.md
        ```
        
        
        static sections (this repo):
        ```
        ./path/to/examples.md
        ./path/to/features.md
        ```
        
        subclass
        ```python
        >>> class Readme_npm(Readme_md):
            ordering = ["badges","description","features","install","examples", ...]
        
            @property
            def description(self):
                return "<b>%s</b>" % json.loads('package.json')['description']
        ```
        
        output
        ```python
        >>> readme.render()             # string
        >>> readme.save("README.md")    # save to file
        ```
        
        custom headers:
        ```python
        >>> Readme_md(".",headers=dict(badges="",how="How it works"))
        ```
        
        disable sections:
        ```python
        >>> Readme_md(".",disabled=["description","badges"])
        ```
Keywords: readme markdown
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/markdown
