Skip to content

Commit

Permalink
cleanup (#2)
Browse files Browse the repository at this point in the history
* yargs
* readme, example and logging
* clear cache
* package info
  • Loading branch information
mrgeorgegray authored Feb 22, 2021
1 parent e27636a commit 4232796
Show file tree
Hide file tree
Showing 13 changed files with 152 additions and 125 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.vscode
.cache
coverage
lib
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
node-version: [10.x, 12.x, 14.x]
node-version: [12.x, 14.x, 15.x]

steps:
- uses: actions/checkout@v2
Expand Down
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# dawn-till-dusk 🧛

A simple tool to display the sunrise, sunset and day length based on your location from the comfort of the command line.

### Example output

![example output](./example.jpg)

### Installation

```
npm i -g @mrgeorgegray/dawn-till-dusk
```

### Usage

```
Usage: dtd <command> [options]
Commands:
index.js dtd Display sunrise & sunset times
Options:
--help, -h Show help [boolean] [default: false]
--version, -v Show version number [boolean]
--clean, -c Clear data cache [boolean] [default: false]
--date, -d Search by date [string] [default: "today"]
--logging, -l Output extra logging info [boolean] [default: false]
Examples:
dtd -d '2021-08-12' display sunrise & sunset times for a given day
```

### Credits

- IP Address data from [https://ip-api.com](ip-api.com)
- Sunrise data from [https://sunrise-sunset.org/api](sunrise-sunset.org/api)
Binary file added example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4232796

Please sign in to comment.