Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pustovitdmytro/code-chronicle

Keep code usage instructions.
https://github.com/pustovitdmytro/code-chronicle

code documentation

Last synced: about 2 months ago
JSON representation

Keep code usage instructions.

Awesome Lists containing this project

README 

        
# code-chronicle

Keep code usage instructions.



[![Version][badge-vers]][npm]

[![Bundle size][npm-size-badge]][npm-size-url]

[![Downloads][npm-downloads-badge]][npm]



[![CodeFactor][codefactor-badge]][codefactor-url]

[![SonarCloud][sonarcloud-badge]][sonarcloud-url]

[![Codacy][codacy-badge]][codacy-url]

[![Total alerts][lgtm-alerts-badge]][lgtm-alerts-url]

[![Language grade][lgtm-lg-badge]][lgtm-lg-url]

[![Scrutinizer][scrutinizer-badge]][scrutinizer-url]



[![Dependencies][badge-deps]][npm]

[![Security][snyk-badge]][snyk-url]

[![Build Status][tests-badge]][tests-url]

[![Coverage Status][badge-coverage]][url-coverage]



[![Commit activity][commit-activity-badge]][github]

[![FOSSA][fossa-badge]][fossa-url]

[![License][badge-lic]][github]



## Table of Contents

  - [Requirements](#requirements)

  - [Installation](#installation)

  - [Usage](#usage)

  - [Contribute](#contribute)



## Requirements

[![Platform Status][node-ver-test-badge]][node-ver-test-url]



To use library you need to have [node](https://nodejs.org) and [npm](https://www.npmjs.com) installed in your machine:



* node `>=10`

* npm `>=6`



Package is [continuously tested][node-ver-test-url] on darwin, linux and win32 platforms. All active and maintenance [LTS](https://nodejs.org/en/about/releases/) node releases are supported.



## Installation



To install the library run the following command



```bash

  npm i --save code-chronicle

```



## Usage



See ready example at [math folder](examples/math/README.md).



## Contribute



Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read [Contributing Guidelines](.github/CONTRIBUTING.md) for details.



[npm]: https://www.npmjs.com/package/code-chronicle

[github]: https://github.com/pustovitDmytro/code-chronicle

[coveralls]: https://coveralls.io/github/pustovitDmytro/code-chronicle?branch=master

[badge-deps]: https://img.shields.io/librariesio/release/npm/code-chronicle.svg

[badge-vers]: https://img.shields.io/npm/v/code-chronicle.svg

[badge-lic]: https://img.shields.io/github/license/pustovitDmytro/code-chronicle.svg

[badge-coverage]: https://coveralls.io/repos/github/pustovitDmytro/code-chronicle/badge.svg?branch=master

[url-coverage]: https://coveralls.io/github/pustovitDmytro/code-chronicle?branch=master



[snyk-badge]: https://snyk-widget.herokuapp.com/badge/npm/code-chronicle/badge.svg

[snyk-url]: https://snyk.io/advisor/npm-package/code-chronicle



[tests-badge]: https://img.shields.io/circleci/build/github/pustovitDmytro/code-chronicle

[tests-url]: https://app.circleci.com/pipelines/github/pustovitDmytro/code-chronicle



[codefactor-badge]: https://www.codefactor.io/repository/github/pustovitdmytro/code-chronicle/badge

[codefactor-url]: https://www.codefactor.io/repository/github/pustovitdmytro/code-chronicle



[commit-activity-badge]: https://img.shields.io/github/commit-activity/m/pustovitDmytro/code-chronicle



[scrutinizer-badge]: https://scrutinizer-ci.com/g/pustovitDmytro/code-chronicle/badges/quality-score.png?b=master

[scrutinizer-url]: https://scrutinizer-ci.com/g/pustovitDmytro/code-chronicle/?branch=master



[lgtm-lg-badge]: https://img.shields.io/lgtm/grade/javascript/g/pustovitDmytro/code-chronicle.svg?logo=lgtm&logoWidth=18

[lgtm-lg-url]: https://lgtm.com/projects/g/pustovitDmytro/code-chronicle/context:javascript



[lgtm-alerts-badge]: https://img.shields.io/lgtm/alerts/g/pustovitDmytro/code-chronicle.svg?logo=lgtm&logoWidth=18

[lgtm-alerts-url]: https://lgtm.com/projects/g/pustovitDmytro/code-chronicle/alerts/



[codacy-badge]: https://app.codacy.com/project/badge/Grade/6c5b8801b70a4debaae685cf47556395

[codacy-url]: https://www.codacy.com/gh/pustovitDmytro/code-chronicle/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pustovitDmytro/code-chronicle&utm_campaign=Badge_Grade



[sonarcloud-badge]: https://sonarcloud.io/api/project_badges/measure?project=pustovitDmytro_code-chronicle&metric=alert_status

[sonarcloud-url]: https://sonarcloud.io/dashboard?id=pustovitDmytro_code-chronicle



[npm-downloads-badge]: https://img.shields.io/npm/dw/code-chronicle

[npm-size-badge]: https://img.shields.io/bundlephobia/min/code-chronicle

[npm-size-url]: https://bundlephobia.com/result?p=code-chronicle



[node-ver-test-badge]: https://github.com/pustovitDmytro/code-chronicle/actions/workflows/npt.yml/badge.svg?branch=master

[node-ver-test-url]: https://github.com/pustovitDmytro/code-chronicle/actions?query=workflow%3A%22Node.js+versions%22



[fossa-badge]: https://app.fossa.com/api/projects/custom%2B24828%2Fcode-chronicle.svg?type=shield

[fossa-url]: https://app.fossa.com/projects/custom%2B24828%2Fcode-chronicle?ref=badge_shield