Skip to content

Commit e0bdfe4

Browse files
committed
Better readme
1 parent 246d797 commit e0bdfe4

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"esm": "tsc --module esnext && cpy dist/index.js dist --rename index.esm.js",
1818
"cjs": "tsc --module commonjs",
1919
"build": "npm run esm && npm run cjs",
20-
"test": "xo && c8 ava",
20+
"test": "xo && ava",
2121
"prepublishOnly": "npm run build"
2222
},
2323
"engines": {
@@ -38,7 +38,6 @@
3838
"@sindresorhus/tsconfig": "^2.0.0",
3939
"@types/node": "^16.11.6",
4040
"ava": "^3.15.0",
41-
"c8": "^7.10.0",
4241
"coveralls": "^3.1.1",
4342
"cpy-cli": "^3.1.1",
4443
"del-cli": "^4.0.1",

readme.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,18 @@
22

33
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
44

5+
## Install
6+
7+
Install `@parsify/hello` using Parsify Desktop - see the [guide](https://docs.parsify.app/documentation/plugins).
8+
59
## Usage
610

7-
```
8-
hello | hello, world!
11+
```bash
12+
hello | hello, world!
13+
# With UPPER_CASE env variable |
14+
hello | HELLO, WORLD!
15+
# Creates a `toUpperCase` function |
16+
toUpperCase("foo") | FOO
917
```
1018

1119
## License

0 commit comments

Comments
 (0)