Skip to content

Commit 2106f5f

Browse files
committed
Fix up README
1 parent 0ab1896 commit 2106f5f

File tree

1 file changed

+14
-32
lines changed

1 file changed

+14
-32
lines changed

README.md

Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,40 @@
11
# Pandera
22

3-
Pandera is a fun little package that lets you replace the word "pandemic" with a randomly selected, similar sounding word (I think we can all agree we're collectively pandemic fatigued 🙃)
3+
Pandera is a fun little package that lets you replace the word "pandemic" with a randomly selected, similar sounding word (I think we can all agree we're collectively pandemic fatigued 🙃).
44

5-
## Installation
5+
## Usage
66

7-
this package can be installed using either `npm` or `yarn`
7+
This package can be installed using either `npm` or `yarn`.
88

9-
### Global Installation
9+
### Use In Your Console
1010

11-
#### `npm` installation
11+
Install by running `npm install --global pandera` or `yarn global add pandera` in your terminal.
1212

13-
`npm install --global pandera`
14-
15-
#### `yarn` installation`
16-
17-
`yarn global add pandera`
13+
You can now call it anywhere by typing `pandera` in your terminal to get a random p-word.
1814

1915
### Importing into your project
2016

21-
#### `npm` installation
22-
23-
`npm install --d pandera`
24-
25-
#### `yarn` installation`
26-
27-
`yarn add --dev pandera`
17+
Install by running `npm install -d pandera` or `yarn add --dev pandera` in your project directory.
2818

29-
after adding the package to your project, you can import the package `pandera` to use it:
19+
After adding the package to your project, you can import the `'pandera'` package to use it:
3020

3121
```js
3222
const pandera = require('pandera');
3323
```
3424

35-
## Usage Instructions
36-
37-
### CLI / Console
38-
39-
after installing `pandera` globally, call it using its name (`pandera`) to receive a random p-word.
40-
41-
### In a project
42-
43-
after importing the package, call `pandera()` to receive a random p-word.
25+
After importing the package, calling the `pandera()` function will return a random p-word.
4426

4527
## Contributing
4628

47-
want to contribute to `pandera`? sweet!
48-
if you'd like to contribute, please open an issue relating to the feature you'd like to work on,
49-
and then open a pr linked to your issue. when you open your pr, please add your changes to the [CHANGELOG](./CHANGELOG.md) under the `### added` or `### fixed` heading, as appropriate, with a link to your pr.
29+
Want to contribute to `pandera`? sweet!
30+
31+
If you'd like to contribute, please open an issue relating to the feature you'd like to work on, and then open a Pull Request linked to your issue. When you open your PR, please add your changes to the [CHANGELOG](./CHANGELOG.md) under the `### added` or `### fixed` heading, as appropriate, with a link to your PR.
5032

51-
don't want to contribute code, but see something missing or broken? open an issue to report any bugs or errors you encounter.
33+
Don't want to contribute code but see something missing or broken? Open an issue to report any bugs or errors you encounter.
5234

5335
### Code of Conduct
5436

55-
before opening an issue or pr, please read (and adhere) to the following:
37+
Before opening an issue or pr, please read (and adhere) to the following:
5638

5739
- be respectful
5840
- be polite

0 commit comments

Comments
 (0)