@xylabs/readme-gen 5.0.94 → 5.0.96

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -71
  2. package/package.json +3 -10
package/README.md CHANGED
@@ -1,95 +1,51 @@
1
1
  # @xylabs/readme-gen
2
2
 
3
- [![logo][]](https://xylabs.com)
3
+ [![npm][npm-badge]][npm-link]
4
+ [![license][license-badge]][license-link]
4
5
 
5
- [![main-build][]][main-build-link]
6
- [![npm-badge][]][npm-link]
7
- [![npm-downloads-badge][]][npm-link]
8
- [![jsdelivr-badge][]][jsdelivr-link]
9
- [![npm-license-badge][]](LICENSE)
10
- [![codacy-badge][]][codacy-link]
11
- [![codeclimate-badge][]][codeclimate-link]
12
- [![snyk-badge][]][snyk-link]
13
- [![socket-badge][]][socket-link]
6
+ > Base functionality used throughout XY Labs TypeScript/JavaScript libraries
14
7
 
8
+ ## Install
15
9
 
16
- Base functionality used throughout XY Labs TypeScript/JavaScript libraries
10
+ Using npm:
17
11
 
18
-
19
-
20
- ## Reference
21
-
22
- **@xylabs/readme-gen**
23
-
24
- ***
25
-
26
- ## Functions
27
-
28
- | Function | Description |
29
- | ------ | ------ |
30
- | [generateReadmeFiles](#functions/generateReadmeFiles) | Generates README.md files for all workspace packages using a shared template. Fills each README with package metadata, an optional body, and auto-generated TypeDoc reference. |
31
-
32
- ### functions
33
-
34
- ### <a id="generateReadmeFiles"></a>generateReadmeFiles
35
-
36
- [**@xylabs/readme-gen**](#../README)
37
-
38
- ***
39
-
40
- ```ts
41
- function generateReadmeFiles(customTemplatePath?: string): Promise<void>;
12
+ ```sh
13
+ npm install {{name}}
42
14
  ```
43
15
 
44
- Generates README.md files for all workspace packages using a shared template.
45
- Fills each README with package metadata, an optional body, and auto-generated TypeDoc reference.
16
+ Using yarn:
46
17
 
47
- ## Parameters
18
+ ```sh
19
+ yarn add {{name}}
20
+ ```
48
21
 
49
- | Parameter | Type |
50
- | ------ | ------ |
51
- | `customTemplatePath?` | `string` |
22
+ Using pnpm:
52
23
 
53
- ## Returns
24
+ ```sh
25
+ pnpm add {{name}}
26
+ ```
54
27
 
55
- `Promise`\<`void`\>
28
+ Using bun:
56
29
 
30
+ ```sh
31
+ bun add {{name}}
32
+ ```
57
33
 
58
- Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
59
34
 
60
- ## Maintainers
35
+ ## License
61
36
 
62
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
63
- - [Matt Jones](https://github.com/jonesmac)
64
- - [Joel Carter](https://github.com/JoelBCarter)
65
- - [Jordan Trouw](https://github.com/jordantrouw)
37
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
66
38
 
67
- ## License
39
+ ## Reference
68
40
 
69
- > See the [LICENSE](LICENSE) file for license details
41
+ ### packages
70
42
 
71
- ## Credits
43
+ ### readme-gen
72
44
 
73
- [Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
45
+ ### .temp-typedoc
74
46
 
75
- [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
76
47
 
77
- [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
78
- [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
79
48
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/readme-gen.svg
80
49
  [npm-link]: https://www.npmjs.com/package/@xylabs/readme-gen
81
- [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
82
- [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
83
- [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
84
- [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
85
- [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
86
- [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
87
-
88
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/readme-gen
89
- [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/readme-gen
90
-
91
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/readme-gen/badge
92
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/readme-gen
93
-
94
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/readme-gen
95
- [socket-link]: https://socket.dev/npm/package/@xylabs/readme-gen
50
+ [license-badge]: https://img.shields.io/npm/l/@xylabs/readme-gen.svg
51
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/readme-gen",
3
- "version": "5.0.94",
3
+ "version": "5.0.96",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "readme",
@@ -31,12 +31,10 @@
31
31
  "exports": {
32
32
  ".": {
33
33
  "types": "./dist/node/index.d.ts",
34
- "import": "./dist/node/index.mjs",
35
34
  "default": "./dist/node/index.mjs"
36
35
  },
37
36
  "./package.json": "./package.json"
38
37
  },
39
- "types": "./dist/node/index.d.ts",
40
38
  "files": [
41
39
  "dist",
42
40
  "!**/*.bench.*",
@@ -45,16 +43,11 @@
45
43
  "README.md"
46
44
  ],
47
45
  "devDependencies": {
48
- "@types/node": "^25.5.2",
49
- "@xylabs/ts-scripts-common": "~7.7.3",
50
- "@xylabs/ts-scripts-yarn3": "^7.7.3",
51
- "@xylabs/tsconfig": "~7.7.3",
52
- "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0",
53
- "esbuild": "^0.28.0",
46
+ "@xylabs/toolchain": "~7.10.4",
47
+ "@xylabs/tsconfig": "~7.10.4",
54
48
  "typescript": "^5"
55
49
  },
56
50
  "peerDependencies": {
57
- "@types/node": "*",
58
51
  "typescript": "~5"
59
52
  },
60
53
  "engines": {