Skip to content

Commit

Permalink
Improve documentation based on online feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
quasipedia committed Aug 8, 2016
1 parent 0e887e3 commit 211b97d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ to your workflow.

## Under the hood

This package downloads the relase information about Atom via the **GitHub API**.
( This is what it makes it platform-independend, BTW).
This package downloads the relase information about Atom via the **GitHub API**
(this is what it makes it platform-independend, BTW).

Based on your configuration settings the package may then notify you of newer
stable or beta versions, or even just informing you are fully up-to-date.


## Usage

The package check for new version of Atom at launch, but it is possible to
The package checks for new version of Atom at launch, but it is possible to
manually perform the check via command palette (search for `geiger`) or the
`Package` menu directly.

Expand All @@ -50,9 +50,10 @@ The boot check can be disabled entirely from the settings.
## Why "geiger"?

Short version: because I am a nerd.

Longer version: because in nature atoms decay over time, transforming themselves
into other elements and generating ionizing particles that can be picked up by a
[geiger counter][1]. If an outadet Atom version has "decayed", this package
[geiger counter][1]. If an outated Atom version has "decayed", this package
should detect it! ;)


Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "geiger",
"main": "./lib/geiger",
"version": "2.0.1",
"description": "A platform-independend Atom new releases notifier",
"description": "A platform-independend notifier for new and beta versions of Atom",
"keywords": [
"beta",
"new-versions",
Expand Down

0 comments on commit 211b97d

Please sign in to comment.