Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,27 @@

### Dependencies

<<DEPENDENCY_INSTRUCTIONS>>
- Node.js

Check warning on line 13 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L13

"Node.js" is misspelled. How about: Nodes, Node, Indexer, Undergoes

### Installing

How/where to download your program. Any modifications needed to be made to files/folders.

Check warning on line 17 in README.md

View check run for this annotation

Prosebot 2.0 / WriteGood

README.md#L17

"be made" may be passive voice

```bash
<<INSTALL_INSTRUCTIONS>>
npm install app
```

## Executing program

How to run the program. Step-by-step bullets.

```bash
<<EXECUTING_INSTRUCTIONS>>
node app.js
```

## Usage

A few motivating and useful examples of how your project can be used. Spice this up with code blocks and potentially more screenshots.

Check warning on line 33 in README.md

View check run for this annotation

Prosebot 2.0 / WriteGood

README.md#L33

"few" is a weasel word

Check warning on line 33 in README.md

View check run for this annotation

Prosebot 2.0 / WriteGood

README.md#L33

"be used" may be passive voice

```javascript
// Use examples
Expand All @@ -47,19 +47,19 @@

### Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

Check warning on line 50 in README.md

View check run for this annotation

Prosebot 2.0 / WriteGood

README.md#L50

"are removed" may be passive voice
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.

Check warning on line 51 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L51

"README.md" is misspelled. How about: Reread, Redeemed, Radiometer
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).

Check warning on line 52 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L52

"README.md" is misspelled. How about: Reread, Redeemed, Radiometer

Check warning on line 52 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L52

"SemVer" is misspelled. How about: Sever, Server, Semester, Severus, Severn, Serve

## Authors

Contributors' names and contact info
- @sith-lords

Check warning on line 57 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L57

"sith-lords" is misspelled. How about: hits-lords, sit-lords, saith-lords, smith-lords, site-lords, sits-lords

## License

This project is licensed under the [Your License] License - see the LICENSE.md file for details

Check warning on line 61 in README.md

View check run for this annotation

Prosebot 2.0 / WriteGood

README.md#L61

"is licensed" may be passive voice

Check warning on line 61 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L61

"LICENSE.md" is misspelled. How about: Licensed, Licensee, Licenses, Licenser, Limitlessness, Unconsumed

## Acknowledgments

Check warning on line 63 in README.md

View check run for this annotation

Prosebot 2.0 / SpellCheck

README.md#L63

"Acknowledgments" is misspelled. How about: Acknowledgments, Acknowledgment, Acknowledgements, Acknowledgment's, Acknowledgment s, Acknowledgement

Inspiration, code snippets, etc.