getrelay 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -10
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -1,24 +1,18 @@
1
1
  # RelayDesgins
2
2
 
3
- RelayDesgins runs through `npx getrelay@latest`.
3
+ RelayDesgins runs as a one-shot CLI command.
4
4
 
5
- It lets users pick a website style from the bundled collection and creates `Relay.md` in the project where the command runs.
5
+ Paste one command, see the website list immediately, choose a style, and Relay creates `Relay.md` in the current project.
6
6
 
7
7
  ## Use
8
8
 
9
- Local checkout:
10
-
11
- ```bash
12
- node .\RelayDesgins\bin\relay.js
13
- ```
14
-
15
9
  Public command:
16
10
 
17
11
  ```bash
18
12
  npx getrelay@latest
19
13
  ```
20
14
 
21
- Relay displays the website list, lets you choose one, and creates:
15
+ That command downloads RelayDesgins, displays the website list, lets you choose one, and creates:
22
16
 
23
17
  ```text
24
18
  Relay.md
@@ -34,7 +28,6 @@ Use Relay.md as the design source for this page.
34
28
 
35
29
  ```bash
36
30
  npx getrelay@latest
37
- npx getrelay@latest list
38
31
  npx getrelay@latest vercel
39
32
  npx getrelay@latest apple --out docs/Relay.md
40
33
  ```
package/package.json CHANGED
@@ -1,10 +1,12 @@
1
1
  {
2
2
  "name": "getrelay",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "RelayDesgins CLI for copying website-inspired design instructions into a project as Relay.md.",
5
5
  "license": "MIT",
6
6
  "type": "commonjs",
7
- "bin": "bin/relay.js",
7
+ "bin": {
8
+ "getrelay": "bin/relay.js"
9
+ },
8
10
  "files": [
9
11
  "bin/",
10
12
  "design-md/",