Skip to content

Commit

Permalink
npm-compatible headings in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wilddeer committed Apr 20, 2015
1 parent 7cf21ff commit fd2592c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
#Sniffer
# Sniffer

Sniffer is a browser/engine/os/device detection tool. Works both in browser and Node.

[Live demo](http://wilddeer.github.io/Sniffer/test/demo.htm) (tests your browser UA string)

[Test suite](http://wilddeer.github.io/Sniffer/test/test.htm)

##You have three options:
## You have three options:

###1. Default Sniffer build
### 1. Default Sniffer build

Get *sniffer.js* from [dist/](https://github.com/wilddeer/Sniffer/tree/master/dist). Drop the script tag in the `<head>`:

Expand Down Expand Up @@ -44,7 +44,7 @@ html.operamini pre code {
}
```

###2. Sniffer module
### 2. Sniffer module

Get *sniffer.module.js* from [dist/](https://github.com/wilddeer/Sniffer/tree/master/dist). It exposes Sniffer function into global scope or via `module.exports`, if available. Compatible with Node. Just feed it a user agent string:

Expand All @@ -56,11 +56,11 @@ It will return detection result, see [“Detection results”](#detection-result

Also available via npm: `npm install snifferjs`.

###3. Pure Sniffer function
### 3. Pure Sniffer function

Get *sniffer.pure.js* from [dist/](https://github.com/wilddeer/Sniffer/tree/master/dist). It contains pure Sniffer function (no wrap, no autolaunch, no css classes, no exports), you decide how to use it.

##Detection results
## Detection results

Sniffer returns an object which looks like this:

Expand Down Expand Up @@ -94,7 +94,7 @@ Sniffer returns an object which looks like this:
}
```

##Detects
## Detects

Class names/shortcodes in square brackets.

Expand Down Expand Up @@ -142,7 +142,7 @@ Class names/shortcodes in square brackets.
- **TV** *[tv]*
- **Proxy broswer** (serverside rendering) *[proxy]*

##License
## License

[MIT license](http://opensource.org/licenses/MIT).

Expand Down

0 comments on commit fd2592c

Please sign in to comment.