@infra-blocks/types 0.5.0-alpha.0 → 0.5.1-alpha.0
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.
- package/README.md +23 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
[](https://github.com/infrastructure-blocks/ts-types/actions/workflows/update-from-template.yml)
|
|
5
5
|
[](https://codecov.io/gh/infrastructure-blocks/ts-types)
|
|
6
6
|
|
|
7
|
+
<<<<<<< HEAD
|
|
7
8
|
Types utility library for Typescript.
|
|
8
9
|
|
|
9
10
|
## Development
|
|
@@ -28,3 +29,25 @@ npm run test
|
|
|
28
29
|
Package publication is fully automated at the CI level. This repository leverages the
|
|
29
30
|
[npm-publish-from-label-workflow](https://github.com/infrastructure-blocks/npm-publish-from-label-workflow)
|
|
30
31
|
workflow as a turnkey, automated mechanism for publishing packages. Refer to its documentation for usage information.
|
|
32
|
+
=======
|
|
33
|
+
This repository is a template to generate repositories meant to hold the source code
|
|
34
|
+
of NPM packages written in TypeScript.
|
|
35
|
+
|
|
36
|
+
Follow these steps after instantiating the template:
|
|
37
|
+
- Remove the [trigger update from template workflow](.github/workflows/trigger-update-from-template.yml)
|
|
38
|
+
- Configure code coverage
|
|
39
|
+
- Update the .nvmrc version file to latest
|
|
40
|
+
- Update the package.json
|
|
41
|
+
- Rename the package name and links
|
|
42
|
+
- Update the `engines` section
|
|
43
|
+
- Update the dependencies
|
|
44
|
+
- Run `nvm install`
|
|
45
|
+
- Run `npm install`
|
|
46
|
+
- Run `npm run compile && npm run lint && npm run test`
|
|
47
|
+
- Edit the `.npmrc` file if you wish to change the defaults. Specifically, if you wish to make your package private.
|
|
48
|
+
- Update the status badges:
|
|
49
|
+
- Remove the `Trigger Update From Template` status badge.
|
|
50
|
+
- Add the `Update From Template` status badge.
|
|
51
|
+
- Rename the rest of the links to point to the right repository.
|
|
52
|
+
- Edit this readme to correspond to the package.
|
|
53
|
+
>>>>>>> template/master
|