Skip to content

Commit

Permalink
update usage, add contributing and resources sections
Browse files Browse the repository at this point in the history
  • Loading branch information
ungoldman committed Feb 17, 2016
1 parent f54cfc0 commit 1013006
Showing 1 changed file with 37 additions and 7 deletions.
44 changes: 37 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# himawari-bg

> Set the latest image from Himawari 8 as your desktop background
> Set the latest image from Himawari 8 as your desktop background.
[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
Expand Down Expand Up @@ -35,7 +35,9 @@ npm install --global himawari-bg

Note: This is alpha quality! Tested only on OSX.

## Command Line Usage
## Usage

### Command Line

You can run `himawari-bg` on the command line after it's been installed globally with `npm`.

Expand All @@ -47,14 +49,17 @@ There are some options available if you'd like to go further:

```
Usage: himawari-bg [options]
--outfile, -o The location to save the resulting image. (default: `~/Pictures/himawari-images/${Date.now()}.jpg`)
--outfile, -o Location to save image. (default: `~/Pictures/himawari-images/${Date.now()}.jpg`)
--zoom, -z The zoom level of the image. Can be 1-5. (default: 2)
--date, -d The time of the picture desired. If you want to get the latest image, use "latest". (default: "latest")
--date, -d Time of the picture desired. Can also be "latest". (default: "latest")
--infrared, -i Capture picture on the infrared spectrum. (default: false)
--parallel, -p Parallelize downloads for increased speeds (can be CPU intensive). (default: true)
--version, -v Show version information.
--help, -h Show help.
```

## Programmatic Usage
### Node.js

`himawari-bg` can also be used as a node module by installing it normally:

Expand Down Expand Up @@ -100,14 +105,39 @@ bg({
})
```

### Acknowledgements
## Acknowledgements

Thanks to [celoyd](https://github.com/celoyd) for the inspiring [`glittering.blue`](https://glittering.blue/) and [jakiestfu](https://github.com/jakiestfu) for creating [`himawari.js`](https://github.com/jakiestfu/himawari.js).

### Addendum
## Addendum

It turns out `himawari.js` was inspired by [this gist](https://gist.github.com/MichaelPote/92fa6e65eacf26219022) by [MichaelPote](https://github.com/MichaelPote) which basically does the exact same thing as `himawari-bg` except in a Windows Powershell environment. So I unwittingly made something inspired by something that was inspired by something that does what I did. Internet! `¯\_(ツ)_/¯`

## Additional Resources

Here are some useful links if you're interested in learning more about the Himawari 8 satellite.

### Official

- [Himawari 8 Real-time Web](http://himawari8.nict.go.jp)
- [Himawari Data Guide](http://www.eorc.jaxa.jp/ptree/userguide.html)
- [Himawari 8/9 Standard Data User's Guide](http://www.data.jma.go.jp/mscweb/en/himawari89/space_segment/hsd_sample/HS_D_users_guide_en_v12.pdf)
- [JAXA account registration (for access to more data)](http://www.eorc.jaxa.jp/ptree/registration_top.html)

### Related Projects

- by @[celoyd](https://github.com/celoyd):
- [Glittering Blue](http://glittering.blue)
- [Himawari 8 animation tutorial](https://gist.github.com/celoyd/b92d0de6fae1f18791ef)
- [deband python script](https://gist.github.com/celoyd/a4dd9202fe5c7978b114)
- [makeaday bash script](https://gist.github.com/celoyd/c2293929ab3fe97ea597)
- [himawari.js](https://github.com/jakiestfu/himawari.js) by @[jakiestfu](https://github.com/jakiestfu)
- [himawari-urls](https://github.com/ngoldman/himawari-urls) by @[ngoldman](https://github.com/ngoldman)

## Contributing

Contributions welcome! Please read the [contributing guidelines](contributing.md) before getting started.

## License

[ISC](LICENSE.md)

0 comments on commit 1013006

Please sign in to comment.