Skip to content

Commit b46811e

Browse files
committed
feat(readme): Improve documentation
1 parent 2e8df29 commit b46811e

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# jslibs
22

3+
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release.yml/badge.svg)
4+
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
5+
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
6+
37
## Description
48

59
A metarepository containing various package I maintain for my typical JavaScript/TypeScript stack.
610

7-
Find out more about each individual package:
11+
Find out more about each individual package here:
812

913
- [`@spuxx/js-utils`](/packages/js-utils/README.md)
1014
- [`@spuxx/browser-utils`](/packages/browser-utils/README.md)

packages/browser-utils/README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# @spuxx/browser-utils
22

3-
![Release pipeline](https://github.com/spuxx1701/browser-utils/actions/workflows/release.yml/badge.svg)
4-
![Main pipeline](https://github.com/spuxx1701/browser-utils/actions/workflows/main.yml/badge.svg)
5-
![Code coverage](https://img.shields.io/codecov/c/github/spuxx1701/browser-utils)
6-
![Latest Release](https://img.shields.io/github/v/release/spuxx1701/browser-utils)
3+
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release.yml/badge.svg)
4+
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
75
![NPM Version](https://img.shields.io/npm/v/%40spuxx%2Fbrowser-utils)
8-
![License](https://img.shields.io/github/license/spuxx1701/browser-utils)
6+
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
97

10-
### Description
8+
## Description
119

12-
`@spuxx/browser-utils` contains a selection of core utilities that I keep reusing across my web projects. The package aims to support single-page applications or other forms of browser-side code.
10+
`@spuxx/browser-utils` contains a selection of core browser-related utilities I keep using across my web projects.

packages/js-utils/README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# @spuxx/js-utils
22

3-
![Release pipeline](https://github.com/spuxx1701/js-utils/actions/workflows/release.yml/badge.svg)
4-
![Main pipeline](https://github.com/spuxx1701/js-utils/actions/workflows/main.yml/badge.svg)
5-
![Code coverage](https://img.shields.io/codecov/c/github/spuxx1701/js-utils)
6-
![Latest Release](https://img.shields.io/github/v/release/spuxx1701/js-utils)
3+
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release.yml/badge.svg)
4+
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
75
![NPM Version](https://img.shields.io/npm/v/%40spuxx%2Fjs-utils)
8-
![License](https://img.shields.io/github/license/spuxx1701/js-utils)
6+
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
97

10-
### Description
8+
## Description
119

12-
`@spuxx/js-utils` contains a selection of core utilities that I keep reusing across my web projects. The package aims to support single-page applications or other forms of browser-side code.
10+
`@spuxx/js-utils` contains a selection of core JavaScript utilities that I keep reusing across my web projects.

0 commit comments

Comments
 (0)