https://github.com/egoist/version-badge

Display a version badge.
https://github.com/egoist/version-badge

Last synced: 4 months ago
JSON representation

Display a version badge.

• Host: GitHub
• URL: https://github.com/egoist/version-badge
• Owner: egoist
• License: mit
• Created: 2017-07-03T13:52:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-12-25T14:42:49.000Z (about 3 years ago)
• Last Synced: 2024-10-10T12:18:04.857Z (4 months ago)
• Language: JavaScript
• Homepage: https://version-badge.egoist.sh
• Size: 104 KB
• Stars: 54
• Watchers: 4
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - version-badge

README

        
# version-badge ![version badge](https://version-badge.egoist.sh/github/egoist/version-badge)

> Display a version badge.

## What?

Designed to be put right next to your project title:

```markdown

# chalk ![version badge](https://version-badge.egoist.sh/npm/chalk)

```

See the title of this README to get the idea :)

Of course you can link the svg to anywhere like the npm page:

```markdown

# chalk [![version badge](version-badge.egoist.sh/npm/chalk)](https://npmjs.com/package/chalk)

```

> **Note:** To make this service keep working, you can [donate](https://github.com/egoist/donate) to support my work.

## Usage

### npm

GET `/npm/:name`

Query:

- `tag`: Default `latest`. Release tag, eg: `beta`

Examples: 

- https://version-badge.egoist.sh/npm/vue

- https://version-badge.egoist.sh/npm/webpack

- https://version-badge.egoist.sh/npm/poi?tag=next

### github

Directly get the version from a file that's hosted on GitHub:

GET `/github/:owner/:repo`


Alias `/gh/:owner/:repo`

Query:

- `file`: Default `package.json`

- `field`: Default `version`

- `branch`: Default `master`

Examples:

- https://version-badge.egoist.sh/github/zeit/next.js

- https://version-badge.egoist.sh/github/facebookincubator/create-react-app?file=packages/create-react-app/package.json

### rust crate

GET `/crate/:name`

Examples: 

- https://version-badge.egoist.sh/crate/rand

- https://version-badge.egoist.sh/crate/clap

### text

GET `/text?text=random_text`

Examples: 

- https://version-badge.egoist.sh/text?text=beta

- https://version-badge.egoist.sh/text?text=coming%20soon

## Prior Art

I made this service because following one does not support npm (directly) and mono repos.

- [npm-version-badge](https://github.com/teelaunch/npm-version-badge)

## License

MIT © [EGOIST](github.com/EGOIST)