readme42 2020.10.26

readme42.com cli

Installation

$ [sudo] pip install readme42

$ [sudo] npm i -g readme42

Examples

https://readme42.com/templates/username/template

{% if examples %}
### Examples
{{ examples }}
{% endif %}

{% if links %}
### Links
{{ links }}
{% endif %}

cli

$ export README42_TOKEN="XXX" # https://readme42.com/token/
$ export README42_TEMPLATE="username/template"
$ readme42 . > README42.md

python api:

url = 'https://api.readme42.com/templates'
headers = {'Authorization': 'Token README42_TOKEN'}

data = dict(
    examples=open('examples.md').read(),
    links=open('links.md').read()
)
r = requests.post(url,headers=headers,data=data)

open('README.md','w').write(r.text)

Links

• readme42.com

readme42.com