1
1
# TypeScript Module Package Skeleton
2
2
3
- [ ![ npm] ( https://img.shields.io/npm/v/@seamapi/makenew-tsmodule.svg )] ( https://www.npmjs.com/package/@seamapi/makenew-tsmodule )
4
3
[ ![ GitHub Actions] ( https://github.com/seamapi/makenew-tsmodule/actions/workflows/check.yml/badge.svg )] ( https://github.com/seamapi/makenew-tsmodule/actions/workflows/check.yml )
5
4
6
5
Package skeleton for a TypeScript module.
@@ -22,7 +21,6 @@ Bootstrap a new TypeScript module in five minutes or less.
22
21
- Continuous testing and package publishing with [ GitHub Actions] .
23
22
- [ Keep a CHANGELOG] .
24
23
- Consistent coding with [ EditorConfig] .
25
- - Badges from [ Shields.io] .
26
24
27
25
[ AVA ] : https://github.com/avajs/ava
28
26
[ ECMAScript module ] : https://nodejs.org/api/esm.html
@@ -34,7 +32,6 @@ Bootstrap a new TypeScript module in five minutes or less.
34
32
[ Keep a CHANGELOG ] : https://keepachangelog.com/
35
33
[ Node.js ] : https://nodejs.org/
36
34
[ Prettier ] : https://prettier.io/
37
- [ Shields.io ] : https://shields.io/
38
35
[ TypeScript ] : https://www.typescriptlang.org/
39
36
[ c8 ] : https://github.com/bcoe/c8
40
37
[ landlubber ] : https://github.com/razor-x/landlubber
@@ -104,7 +101,14 @@ and summarized under [Releases].
104
101
105
102
## Installation
106
103
107
- Add this as a dependency to your project using [ npm] with
104
+ Add this as a dependency to your project using [ npm]
105
+ by adding the line below to your project's ` .npmrc ` ,
106
+
107
+ ```
108
+ @seamapi:registry=https://npm.pkg.github.com
109
+ ```
110
+
111
+ and installing the package with
108
112
109
113
```
110
114
$ npm install @seamapi/makenew-tsmodule
@@ -192,8 +196,6 @@ _GitHub Actions should already be configured: this section is for reference only
192
196
193
197
The following repository secrets must be set on [ GitHub Actions] :
194
198
195
- - ` NPM_TOKEN ` : npm token for installing and publishing packages.
196
-
197
199
These must be set manually.
198
200
199
201
### Secrets for Optional GitHub Actions
0 commit comments