Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
heliomarpm committed Oct 11, 2023
1 parent a2eab0b commit 5ed590b
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 47 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<span id="top"></span>
<h1 align="center">
<br> KeyValues Storage
<br>🎲 KeyValues Storage

[![DeepScan grade](https://deepscan.io/api/teams/19612/projects/25344/branches/791226/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=19612&pid=25344&bid=791226) [![CodeFactor](https://www.codefactor.io/repository/github/heliomarpm/keyvalues-storage/badge)](https://www.codefactor.io/repository/github/heliomarpm/keyvalues-storage) ![CodeQL](https://github.com/heliomarpm/keyvalues-storage/actions/workflows/codeql.yml/badge.svg) ![Publish](https://github.com/heliomarpm/keyvalues-storage/actions/workflows/publish.yml/badge.svg) <a href="https://navto.me/heliomarpm" target="_blank"><img src="https://navto.me/assets/navigatetome-brand.png" width="32"/></a>
[![DeepScan grade][url-deepscan-badge]][url-deepscan]
[![CodeFactor][url-codefactor-badge]][url-codefactor]
![CodeQL][url-codeql]<!-- ![Publish][url-publish] --> [![NPM version][url-npm-badge]][url-npm]
[![Downloads][url-downloads-badge]][url-downloads]
<a href="https://navto.me/heliomarpm" target="_blank"><img src="https://navto.me/assets/navigatetome-brand.png" width="32"/></a>

![lodash](https://img.shields.io/github/package-json/dependency-version/heliomarpm/keyvalues-storage/lodash)
![write-file-atomic](https://img.shields.io/github/package-json/dependency-version/heliomarpm/keyvalues-storage/write-file-atomic)
![jest](https://img.shields.io/github/package-json/dependency-version/heliomarpm/keyvalues-storage/dev/jest)
<!-- ![jest](https://img.shields.io/github/package-json/dependency-version/heliomarpm/keyvalues-storage/dev/jest) -->
</h1>

<p align="center">
Expand Down Expand Up @@ -143,7 +147,7 @@ ___

# Contributing

Please make sure to read the [Contributing Guide](https://github.com/heliomarpm/keyvalues-storage/blob/master/docs/CONTRIBUTING.md) before making a pull request.
Please make sure to read the [Contributing Guide](docs/CONTRIBUTING.md) before making a pull request.


Thank you to all the people who already contributed to project!
Expand Down Expand Up @@ -188,4 +192,17 @@ If you appreciate that, please consider donating to the Developer.

## License

[MIT © Heliomar P. Marques](https://github.com/heliomarpm/keyvalues-storage/blob/main/LICENSE) <a href="#top">🔝</a>
[MIT © Heliomar P. Marques](LICENSE) <a href="#top">🔝</a>


----
[url-npm]: https://www.npmjs.com/package/@heliomarpm/kvs
[url-npm-badge]: https://img.shields.io/npm/v/@heliomarpm/kvs.svg
[url-downloads-badge]: https://img.shields.io/npm/dm/@heliomarpm/kvs.svg
[url-downloads]: http://badge.fury.io/js/@heliomarpm/kvs.svg
[url-deepscan-badge]: https://deepscan.io/api/teams/19612/projects/25344/branches/791226/badge/grade.svg
[url-deepscan]: https://deepscan.io/dashboard#view=project&tid=19612&pid=25344&bid=791226
[url-codefactor-badge]: https://www.codefactor.io/repository/github/heliomarpm/keyvalues-storage/badge
[url-codefactor]: https://www.codefactor.io/repository/github/heliomarpm/keyvalues-storage
[url-codeql]: https://github.com/heliomarpm/keyvalues-storage/actions/workflows/codeql.yml/badge.svg
[url-publish]: https://github.com/heliomarpm/keyvalues-storage/actions/workflows/publish.yml/badge.svg
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
],
"scripts": {
"build": "tsc",
"test": "jest",
"test": "jest --detectOpenHandles",
"test:c": "jest --coverage",
"commit": "node ./cmd/modules/release/index.js"
},
Expand All @@ -54,4 +54,4 @@
"@types/lodash": "^4.14.194",
"@types/write-file-atomic": "^4.0.0"
}
}
}
6 changes: 3 additions & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import { KeyValues } from "./keyvalues";

export { KeyValues }
import { KeyValues } from "./keyvalues";

export { KeyValues }
4 changes: 2 additions & 2 deletions src/keyvalues.ts
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ export class KeyValues {
const [keyPath, value] = args;
const obj = await this.fnc.loadKeyValues<T>();

_set(obj as Object, keyPath, value);
_set(obj as {}, keyPath, value);

return this.fnc.saveKeyValues(obj);
}
Expand Down Expand Up @@ -512,7 +512,7 @@ export class KeyValues {
const [keyPath, value] = args;
const obj = this.fnc.loadKeyValuesSync<T>();

_set(obj as Object, keyPath, value);
_set(obj as {}, keyPath, value);

this.fnc.saveKeyValuesSync(obj);
}
Expand Down
35 changes: 0 additions & 35 deletions test/npmlink.test.ts

This file was deleted.

0 comments on commit 5ed590b

Please sign in to comment.