https://github.com/eiriksm/readmeify

A script to put typical stuff on top of README.md
https://github.com/eiriksm/readmeify

Last synced: 12 days ago
JSON representation

A script to put typical stuff on top of README.md

• Host: GitHub
• URL: https://github.com/eiriksm/readmeify
• Owner: eiriksm
• Created: 2014-03-12T17:31:43.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-27T20:29:35.000Z (over 7 years ago)
• Last Synced: 2024-12-12T14:40:25.632Z (17 days ago)
• Language: JavaScript
• Size: 29.3 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Readmeify

==

[![Build Status](https://travis-ci.org/eiriksm/readmeify.svg?branch=master)](https://travis-ci.org/eiriksm/readmeify)

[![Coverage Status](https://coveralls.io/repos/eiriksm/readmeify/badge.svg?branch=master)](https://coveralls.io/r/eiriksm/readmeify?branch=master)

[![Code Climate](https://codeclimate.com/github/eiriksm/readmeify/badges/gpa.svg)](https://codeclimate.com/github/eiriksm/readmeify)

[![Dependency Status](https://david-dm.org/eiriksm/readmeify.svg)](https://david-dm.org/eiriksm/readmeify)

Generates standard stuff on top of README.md. In fact, this file (the top of it)

is generated by readmeify.

The format is highly opinionated. It places the badges on line 3, right after a

heading and a horizontal line. The `.travis.yml` file is told to run `npm test`

if generated by this tool.

### @Todo

- More tests.

- More unicorny badges.

### Contribute

If you want to add some more badges, add some config to make this less

opinionated, think the code stinks or something completely different - pull

requests are of course welcome.

### Tests

Tests are run with mocha, and starts if you just type `make test`.

### Licence

MIT