Skip to content

Commit 5e0ba14

Browse files
joyqigithub-actions[bot]
authored andcommitted
Setup project for node-dan-api [skip ci]
1 parent 40243ad commit 5e0ba14

3 files changed

Lines changed: 7 additions & 74 deletions

File tree

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1 @@
1-
# TypeScript Module Template
2-
3-
This is a template for creating a npm module written in TypeScript.
4-
5-
## Usage
6-
7-
Just click the "Use this template" button and create a new repository.
8-
9-
## Initialization
10-
11-
1. Change these lines in `package.json`:
12-
```json
13-
{
14-
"keywords": ["your", "keywords", "<"],
15-
"description": "Your module description here <",
16-
"license": "Your license here <",
17-
```
18-
2. Change the `README.md` file to your needs.
19-
3. Add LICENSE file if you want to.
20-
21-
## `engines` field in `package.json`
22-
23-
### `node`
24-
25-
You can specify a node version in this field. We'll use this version to set up the CI environment.
26-
27-
### `npm` / `yarn` / `pnpm`
28-
29-
You can specify a package manager in this field. We'll use this package manager to install dependencies.
30-
31-
## Project Structure
32-
33-
Just like a normal TypeScript project, but with a `src` folder.
34-
We use [mocha](https://mochajs.org/) for testing, all test files should be ended with `.spec.ts`.
35-
36-
```
37-
src/
38-
index.ts
39-
your-module.ts
40-
your-module.spec.ts
41-
```
42-
43-
## Publishing to npm
44-
45-
Generate a new npm token and add it to the repository secrets as `NPM_TOKEN`. Then, create a new release and the CI will automatically publish the package to npm.
1+
# node-dan-api

package.json

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
{
2-
"name": "typescript-module-template",
2+
"name": "node-dan-api",
33
"keywords": [],
4-
"author": "",
4+
"author": "namebeta",
55
"license": "",
6-
"description": "",
6+
"description": "Node.js client library for dan.com api.",
77
"repository": {
88
"type": "git",
9-
"url": ""
9+
"url": "git+https://github.com/namebeta/node-dan-api.git"
1010
},
11-
"homepage": "",
11+
"homepage": "https://github.com/namebeta/node-dan-api#readme",
1212
"bugs": {
13-
"url": ""
13+
"url": "https://github.com/namebeta/node-dan-api/issues"
1414
},
15-
1615
"version": "0.0.1",
17-
1816
"main": "lib/index.js",
1917
"module": "lib/index.js",
2018
"types": "lib/index.d.ts",

0 commit comments

Comments
 (0)