@sayan_shankhari/sem_ver
Version:
Semantic Version w.r.t. Git Log
128 lines (83 loc) • 4.1 kB
Markdown
# semver
Semantic Versioning
___
Sample Query:
```
http://127.0.0.1:3000/?user={Your GitHub Username}&path={User or Organization Name}&repo={Repository Name}&branch={Branch Name}
```
[](https://github.com/TheScienceUniverse/semver)
[](https://github.com/TheScienceUniverse/semver/actions/workflows/node.js.yml)
[](https://github.com/TheScienceUniverse/semver/issues)
[](https://discord.gg/DEYW7vZkm7)
## Overview
- semver is a minimal badge generator that is written and run in server side NodeJS.
## Usage
### Package manager
Using npm:
```bash
$ npm install semver
```
Using bower:
```bash
$ bower install semver
```
Using yarn:
```bash
$ yarn add semver
```
Using pnpm:
```bash
$ pnpm add semver
```
Once the package is installed, you can import the library using `import` or `require` approach:
```js
import semver from 'semver/app/';
```
You can also use the default export, since the named export is just a re-export from the semver factory:
```js
import semver from 'semver/app/';
console.log (semver .create ('Proper URI'));
```
If you use `require` for importing, **only default export is available**:
```js
const semver = require ('semver/app/');
```
## Example
```js
import semver from 'semver';
//const semver = require('semver'); // legacy way
// Make a request for a user with a given inputs from brouser URI
http .createServer (async (req, res) => {
const url_obj = new URL (req .url, `http://${req .headers .host}`);
let response = await router .get (url_obj);
res .writeHead (response .status, {
'Content-Type': response .type,
'Content-Length': response .data .toString() .length,
'Expires': new Date() .toUTCString()
});
res .end (response .data);
}) .listen (config .port, config .host, () => {
console .log (`Server running at http://${config .host}:${config .port}/`);
});
```
> **Note**: `async/await` is part of ECMAScript 2017 and is not supported in Internet
> Explorer and older browsers, so use with caution.
## Showcase
___
## History
- Hi, this is the inititiator of this repo. After searching in npm registri could not find dynamic version badge for markdown, so creating this, feen free to test, use and contribute.
- Please try this tool on systems (computer, mobile, embded systems having nodejs running).
## [🤝 Contributing](./CONTRIBUTING.md)
## [📜 Code of Conduct](./CODE_OF_CONDUCT.md)
## [🔒 Security](./SECURITY.md)
## 💝 Support
If you like this DSA Project and would like to support & appreciate it via donation then I'll gladly accept it.
[](https://ko-fi.com/sayan_shankhari)
[](https://www.buymeacoffee.com/sayan.shankhari)
[]()
[](https://www.paypal.com/paypalme/the01guy)
[]()
[]()
[]()
[]()