docs: update README

aspida · Aug 15, 2024 · 026a781 · 026a781
1 parent bb1b49c
commit 026a781
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,24 @@
 
 ## Getting Started
 
+```sh
+$ npx aspida2openapi
+```
+
+## Cli options
+
+### `-o`, `--output`
+
+can change openapi file name
+
+### `-c`, `--config`
+
+path to an aspida config file
+
+### `--version`
+
+display version
+
 ## License
 
 aspida2openapi is licensed under a [MIT License](https://github.com/aspida/aspida2openapi/blob/main/LICENSE).
diff --git a/package.json b/package.json
@@ -27,8 +27,7 @@
   "keywords": [
     "typescript",
     "aspida",
-    "openapi",
-    "swagger"
+    "openapi"
   ],
   "dependencies": {
     "aspida": "^1.14.0",