Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more detailed descriptions to README documentation #464

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add more detailed descriptions to README documentation #464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 35 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,55 +17,79 @@

This is a website to find geeky and cheesy phrases to send to your **Loved Ones**, and I am sure they will love em.


You know how sometimes you find these really geeky quotes and wish the world had more of them? Yeah, geeksay fixes that. Try it out at [http://geeksay.xyz](http://geeksay.xyz)

🤓 Featured on [npm weekly](https://medium.com/npm-inc/npm-weekly-221-npm-6-12-1-is-here-oss-sustainability-open-rfc-calls-more-eb6506c83311) 🤓

## Install
geeksay can be used as a module/package.
To install geeksay, run the following command in the command line:

```
npm install -g geeksay
```

## Usage
The following are examples of how you can use geeksay, but feel free to use/test your own geeky and cheesy phrases.
geeksay supports a lot more than just the phrases in the examples below, so have fun with it!

### Module
geeksay can be used as a JavaScript module.
The following is an example of loading the geeksay module and using it in your program:

```
const geeksay = require('geeksay');
console.log(geeksay(`go hard or go home`)); // go hard || go 127.0.0.1
console.log(geeksay(`please make me a sandwich`)); // sudo make me a sandwich
const geeksay = require('geeksay'); // Loads the geeksay module into your program/application
console.log(geeksay(`go hard or go home`)); // Example output: go hard || go 127.0.0.1
console.log(geeksay(`please make me a sandwich`)); // Example output: sudo make me a sandwich
```

### CLI
geeksay can also be used in the CLI.

#### npm
geeksay can be used with npm.
First, install geeksay using the npm install command and then test it out!
The following are examples of using geeksay in the command line:

```
$ npm install geeksay
$ geeksay copy that // ctrl+c that
$ geeksay to be or not to be, that is the question // to be || ! to be, that is the question
$ npm install geeksay // See Install section
$ geeksay copy that // Example output: ctrl+c that
$ geeksay to be or not to be, that is the question // Example output: to be || ! to be, that is the question
```

> Note: **Do not** put quotes around the phrase, even if it contains spaces!

### npx
#### npx
geeksay can also be used with npx.
npx is an npm package runner that allows us to execute any JavaScript npm package without installing the package itself.
The following are examples of this:

```
$ npx geeksay i was 5 and he was 6 // i was 101 && he was 110
$ npx geeksay sometimes i just need a break // sometimes i just need a <br>
$ npx geeksay i was 5 and he was 6 // Example output: i was 101 && he was 110
$ npx geeksay sometimes i just need a break // Example output: sometimes i just need a <br>
```

> Note: **Do not** put quotes around the phrase, even if it contains spaces!

## Test
The following command runs the test command as defined in the package.json file.
You can execute this command by first cloning the repo (git clone) and then locally navigating to the repo folder on your computer.
Now you can run the command below.

```
$ npm test
```

> Note: If you receive any errors, you might have to install mocha first.

## Demo

This is what you actually want, right? Right?? [There you go!](http://geeksay.xyz) 👏

Here is geeksay in action:

![](demo.gif)

![](save.jpg)
![](home.jpg)
![](break.jpg)
![](break.jpg)