https://github.com/indexzero/roadmap

A simple CLI script to generate a formatted Roadmap from Github issues and milestones
https://github.com/indexzero/roadmap

Last synced: 4 months ago
JSON representation

A simple CLI script to generate a formatted Roadmap from Github issues and milestones

• Host: GitHub
• URL: https://github.com/indexzero/roadmap
• Owner: indexzero
• License: mit
• Created: 2013-08-08T23:59:40.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2013-08-09T03:04:04.000Z (almost 13 years ago)
• Last Synced: 2025-09-26T10:54:49.622Z (9 months ago)
• Language: JavaScript
• Size: 61.5 KB
• Stars: 54
• Watchers: 3
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Generates a `README.md` file from all milestones and issues in a given Github repository.

## Usage

To generate a `README.md` roadmap just install `roadmap` and run it.

```

  $ npm install -g roadmap

  

  $ roadmap

  Generates a `README.md` file from all milestones and issues in a given Github repository.

  Options:

    --owner, -o     [required]

    --username, -u  [required]

    --password, -p  [required]

    --repo, -r      [default: "roadmap"]

```

e.g.

```

  bin/roadmap -u indexzero -p sup3rs3cr3tz -r a-repo -o indexzero

  info:    indexzero/authenticate

  info:    indexzero/a-repo/milestones

  info:    Remaining requests: 4975

  info:    indexzero/a-repo/issues/1

  info:    indexzero/a-repo/issues/2

  info:    Remaining requests: 4974

  info:    Remaining requests: 4973

  info:    Done generating Roadmap from Github repo: a-repo

  info:    Saving information to README.md

```

#### LICENSE: MIT

#### Author: [Charlie Robbins](http://nodejitsu.com)