Skip to content

Commit bab1e8a

Browse files
committed
docs: Improve readmes
1 parent 7867383 commit bab1e8a

File tree

4 files changed

+65
-6
lines changed

4 files changed

+65
-6
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,18 @@
66
![nest-utils](https://github.com/spuxx1701/jslibs/actions/workflows/release_nest_utils.yml/badge.svg)
77
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
88

9-
## Description
9+
<!-- vscode-markdown-toc -->
10+
11+
- 1. [Description](#Description)
12+
- 2. [Releases](#Releases)
13+
14+
<!-- vscode-markdown-toc-config
15+
numbering=true
16+
autoSave=true
17+
/vscode-markdown-toc-config -->
18+
<!-- /vscode-markdown-toc -->
19+
20+
## 1. <a name='Description'></a>Description
1021

1122
A metarepository containing various package I maintain for my typical JavaScript/TypeScript stack.
1223

@@ -15,7 +26,7 @@ Find out more about each individual package here:
1526
- [`@spuxx/js-utils`](/packages/js-utils/README.md)
1627
- [`@spuxx/browser-utils`](/packages/browser-utils/README.md)
1728

18-
## Releases
29+
## 2. <a name='Releases'></a>Releases
1930

2031
Releases are manifest-driven and performed through [`release-please`](https://duckduckgo.com/?q=release-manifest.json&t=ffab&ia=web). Read more about it here:
2132

packages/browser-utils/README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,25 @@
22

33
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
44
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release_browser_utils.yml/badge.svg)
5-
![NPM Version](https://img.shields.io/npm/v/%40spuxx%2Fbrowser-utils)
5+
![npm version](https://img.shields.io/npm/v/%40spuxx%2Fbrowser-utils)
6+
![npm bundle size](https://img.shields.io/bundlephobia/min/%40spuxx%2Fbrowser-utils)
67
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
78

8-
## Description
9+
<!-- vscode-markdown-toc -->
10+
11+
- 1. [Description](#Description)
12+
- 2. [Links](#Links)
13+
14+
<!-- vscode-markdown-toc-config
15+
numbering=true
16+
autoSave=true
17+
/vscode-markdown-toc-config -->
18+
<!-- /vscode-markdown-toc -->
19+
20+
## 1. <a name='Description'></a>Description
921

1022
`@spuxx/browser-utils` contains a selection of core browser-related utilities I keep using across my web projects.
23+
24+
## 2. <a name='Links'></a>Links
25+
26+
- [Source](https://github.com/spuxx1701/jslibs)

packages/js-utils/README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,25 @@
22

33
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
44
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release_js_utils.yml/badge.svg)
5-
![NPM Version](https://img.shields.io/npm/v/%40spuxx%2Fjs-utils)
5+
![npm version](https://img.shields.io/npm/v/%40spuxx%2Fjs-utils)
6+
![npm bundle size](https://img.shields.io/bundlephobia/min/%40spuxx%2Fjs-utils)
67
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
78

9+
<!-- vscode-markdown-toc -->
10+
11+
- 1. [Description](#Description)
12+
- 2. [Links](#Links)
13+
14+
<!-- vscode-markdown-toc-config
15+
numbering=true
16+
autoSave=true
17+
/vscode-markdown-toc-config -->
18+
<!-- /vscode-markdown-toc -->
19+
820
## Description
921

1022
`@spuxx/js-utils` contains a selection of core JavaScript utilities that I keep reusing across my web projects.
23+
24+
## Links
25+
26+
- [Source](https://github.com/spuxx1701/jslibs)

packages/nest-utils/README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,25 @@
22

33
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
44
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release_nest_utils.yml/badge.svg)
5-
![NPM Version](https://img.shields.io/npm/v/%40spuxx%2Fnest-utils)
5+
![npm version](https://img.shields.io/npm/v/%40spuxx%2Fnest-utils)
6+
![npm bundle size](https://img.shields.io/bundlephobia/min/%40spuxx%2Fnest-utils)
67
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
78

9+
<!-- vscode-markdown-toc -->
10+
11+
- 1. [Description](#Description)
12+
- 2. [Links](#Links)
13+
14+
<!-- vscode-markdown-toc-config
15+
numbering=true
16+
autoSave=true
17+
/vscode-markdown-toc-config -->
18+
<!-- /vscode-markdown-toc -->
19+
820
## Description
921

1022
`@spuxx/nest-utils` contains a selection of core utilities that I keep reusing in my NestJS applications.
23+
24+
## Links
25+
26+
- [Source](https://github.com/spuxx1701/jslibs)

0 commit comments

Comments
 (0)