Skip to content

Commit 1f3fce9

Browse files
author
wangw19
committed
feat: add license
1 parent 68f795e commit 1f3fce9

File tree

4 files changed

+39
-11
lines changed

4 files changed

+39
-11
lines changed

.github/workflows/npm-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ jobs:
1818
registry-url: https://registry.npmjs.org/
1919
- run: yarn install
2020
- run: yarn ci
21-
- run: npm publish --tag beta
21+
- run: npm publish --access=public
2222
env:
2323
NODE_AUTH_TOKEN: ${{secrets.npm_token}}

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# typescript-to-jsonschema
1+
# fast-typescript-to-jsonschema
22

3-
![Test](https://github.com/yunke-yunfly/typescript-to-jsonschema/workflows/Test/badge.svg)
3+
![Test](https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/workflows/Test/badge.svg)
44

55
生成typescript类型的jsonschema数据
66

@@ -14,7 +14,7 @@
1414
- 1.安装依赖
1515

1616
```js
17-
yarn add typescript-to-jsonschema -D
17+
yarn add fast-typescript-to-jsonschema -D
1818
```
1919

2020
- 2.创建`type.ts`文件,内容如下:
@@ -30,7 +30,7 @@ interface ITest {
3030
- 3.创建`test.js`文件,内容如下:
3131

3232
```js
33-
const { default: genTypeSchema } = require('typescript-to-jsonschema');
33+
const { default: genTypeSchema } = require('fast-typescript-to-jsonschema');
3434
const path = require('path');
3535

3636
// 目标文件
@@ -80,7 +80,7 @@ node ./test.js
8080
```
8181

8282
- example 案例地址:
83-
https://github.com/wangweianger/typescript-to-jsonschema/tree/master/example
83+
https://github.com/wangweianger/fast-typescript-to-jsonschema/tree/master/example
8484

8585
## 注释
8686

@@ -199,6 +199,6 @@ interface Interface_4 {
199199

200200
我们非常欢迎您的贡献,您可以通过以下方式与我们共建。
201201

202-
- 提交[GitHub 问题](https://github.com/yunke-yunfly/typescript-to-jsonschema/issues)以报告错误或提出问题。
203-
- 提出[拉取请求](https://github.com/yunke-yunfly/typescript-to-jsonschema/pulls)以改进我们的代码。
202+
- 提交[GitHub 问题](https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/issues)以报告错误或提出问题。
203+
- 提出[拉取请求](https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/pulls)以改进我们的代码。
204204
- [贡献指南](CONTRIBUTING.md)

package.json

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
{
2-
"name": "typescript-to-jsonschema",
3-
"version": "0.0.1-beta.2",
2+
"name": "fast-fast-typescript-to-jsonschema",
3+
"version": "0.0.1",
4+
"description": "fast-typescript-to-jsonschema generates JSON Schema files from your Typescript sources.",
45
"main": "./dist/index.js",
56
"typings": "dist/index.d.ts",
6-
"repository": "https://github.com/yunke-yunfly/typescript-to-jsonschema",
7+
"repository": "https://github.com/yunke-yunfly/fast-typescript-to-jsonschema",
78
"author": "zane <wangw19@mingyuanyun.com>",
89
"license": "MIT",
10+
"keywords": [
11+
"typescript",
12+
"json",
13+
"jsonschema",
14+
"schema"
15+
],
916
"scripts": {
1017
"build": "gts clean && tsc",
1118
"dev": "tsc --watch",

0 commit comments

Comments
 (0)