Skip to content

Commit 17e67f8

Browse files
committed
clean up yeoman references
1 parent 5622e16 commit 17e67f8

File tree

3 files changed

+16
-20
lines changed

3 files changed

+16
-20
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# generator-openapi-repo [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
2-
> Yeoman generator for OpenAPI(fka Swagger) repo to help you share spec for your API
1+
# create-openapi-repo [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
2+
> Generator for OpenAPI(fka Swagger) repository
33
44
<center>
55

@@ -34,25 +34,21 @@ This generator helps to create a GitHub repo with the following features:
3434

3535
We assume you already have [node.js](https://nodejs.org/) installed.
3636

37-
- First, install [Yeoman](http://yeoman.io) and `generator-openapi-repo`:
37+
- Install `create-openapi-repo` globally:
3838
```bash
39-
npm install -g yo
40-
npm install -g generator-openapi-repo
39+
npm install -g create-openapi-repo
4140
```
42-
- Then [create GitHub repo](https://help.github.com/articles/create-a-repo/#create-a-new-repository-on-github) where your OpenAPI spec will live.
41+
or use [`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b):
42+
43+
```bash
44+
npx create-openapi-repo <spec-root>
45+
```
46+
- [Create GitHub repo](https://help.github.com/articles/create-a-repo/#create-a-new-repository-on-github) where your OpenAPI spec will live.
4347
- [Clone your repo](https://help.github.com/articles/cloning-a-repository/) and execute the following command inside it:
4448
```bash
45-
yo openapi-repo
49+
create-openapi-repo .
4650
```
4751
- Commit and push your changes to the GitHub and follow instruction from `README.md` of your newly created repo.
48-
**Note**: don't forget to commit the `.yo-rc.json` file, it contains all answers gave to yeoman, and they are reused during the update procedure.
49-
50-
## Updating an existing project
51-
- First make sure you have committed everything or have a backup
52-
- Run `yo openapi-repo` over the project again
53-
- `yo` will ask you for each file if you want to overwrite
54-
- For those files you haven't edited, just say yes
55-
- For the other ones, type `d` for diff and see what's changed
5652

5753
[npm-image]: https://badge.fury.io/js/generator-openapi-repo.svg
5854
[npm-url]: https://npmjs.org/package/generator-openapi-repo

logo.png

-139 KB
Loading

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
{
22
"name": "generator-openapi-repo",
33
"version": "1.0.1",
4-
"description": "Yeoman generator for OpenAPI(fka Swagger) repo to help you share spec for your API",
4+
"description": "Generator of OpenAPI(fka Swagger) repository",
55
"author": {
66
"name": "Roman Hotsiy",
77
"email": "gotsijroman@gmail.com"
88
},
99
"files": [
10-
"generators"
10+
"lib",
11+
"cli.js"
1112
],
12-
"main": "generators/index.js",
13+
"bin": "cli.js",
1314
"keywords": [
1415
"Swagger",
1516
"OpenAPI",
1617
"ReDoc",
17-
"SwaggerUI",
18-
"yeoman-generator"
18+
"SwaggerUI"
1919
],
2020
"dependencies": {
2121
"chalk": "^2.3.1",

0 commit comments

Comments
 (0)