@infra-blocks/types 0.5.3 → 0.6.0-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 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,29 @@
|
|
|
1
1
|
# ts-types
|
|
2
2
|
[](https://github.com/infrastructure-blocks/ts-types/actions/workflows/build.yml)
|
|
3
|
-
[](https://github.com/infrastructure-blocks/ts-types/actions/workflows/release.yml)
|
|
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.
|
|
9
|
+
=======
|
|
10
|
+
This repository is a template to generate repositories meant to hold the source code
|
|
11
|
+
of NPM packages written in TypeScript.
|
|
12
|
+
|
|
13
|
+
Follow these steps after instantiating the template:
|
|
14
|
+
- Remove the [trigger update from template workflow](.github/workflows/trigger-update-from-template.yml)
|
|
15
|
+
- Do a global search & replace for `ts-lib-template` and replace it with the name of your repository
|
|
16
|
+
- Likewise, do a search and replace for the *name of the package* in the `package.json` file
|
|
17
|
+
- Configure code coverage
|
|
18
|
+
- Update the status badges:
|
|
19
|
+
- Replace the `Trigger Update From Template` status badge for the `Update From Template` status badge.
|
|
20
|
+
- Update package.json
|
|
21
|
+
- Edit the search keywords
|
|
22
|
+
- Edit the description
|
|
23
|
+
- Describe the package and its usage in this readme.
|
|
24
|
+
- Replace the [changelog](CHANGELOG.md) with the [stub](CHANGELOG-STUB.md) and prepare it for the first version of
|
|
25
|
+
the package that will be released.
|
|
26
|
+
- Run `nvm install && npm install`
|
|
27
|
+
- Run `npm run compile && npm run lint && npm run test`
|
|
28
|
+
- Edit the `.npmrc` file if you wish to change the defaults. Specifically, if you wish to make your package private.
|
|
29
|
+
>>>>>>> template/master
|