Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sinchang/year-progress

year progress bar
https://github.com/sinchang/year-progress

nodejs npm progressbar sao year

Last synced: 21 days ago
JSON representation

year progress bar

Awesome Lists containing this project

README

        

# year-progress

[![NPM version](https://img.shields.io/npm/v/year-progress.svg?style=flat)](https://npmjs.com/package/year-progress) [![NPM downloads](https://img.shields.io/npm/dm/year-progress.svg?style=flat)](https://npmjs.com/package/year-progress) [![CircleCI](https://circleci.com/gh/sinchang/year-progress/tree/master.svg?style=shield)](https://circleci.com/gh/sinchang/year-progress/tree/master) [![codecov](https://codecov.io/gh/sinchang/year-progress/branch/master/graph/badge.svg)](https://codecov.io/gh/sinchang/year-progress)

## Install

```bash
npm i year-progress
```

## Usage

```js
const yearProgress = require('year-progress')

yearProgress()
//=> { yearBar: '▓▓▓▓▓▓░░░░░░░░░░', percent: 41 }
```

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

**year-progress** © [sinchang](https://github.com/sinchang), Released under the [MIT](./LICENSE) License.

Authored and maintained by sinchang with help from contributors ([list](https://github.com/sinchang/year-progress/contributors)).

> [sinchang.me](https://sinchang.me) · GitHub [@sinchang](https://github.com/sinchang) · Twitter [@sinchangwen](https://twitter.com/sinchangwen)