Skip to content

Commit 9224320

Browse files
author
James Watts
committed
Updated README
1 parent 0962ad6 commit 9224320

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1-
# nano-browser
2-
browser plugin for the nano JavaScript framework
1+
nano Browser plugin
2+
===================
3+
4+
The **Browser** plugin for the [nano JavaScript framework](http://nanojs.org) provides detailed information for the current browser environment.
5+
6+
Installation
7+
------------
8+
9+
To add the **Browser** plugin include it in the `<head>` of the document, after the core framework:
10+
11+
```html
12+
<!DOCTYPE html>
13+
<html>
14+
<head>
15+
<title>My Site</title>
16+
<script src="path/to/nano.js"></script>
17+
<script src="path/to/nano.browser.js"></script>
18+
</head>
19+
<body>
20+
21+
<!-- your content here -->
22+
23+
</body>
24+
</html>
25+
```
26+
27+
Documentation
28+
-------------
29+
30+
Full documentation for the plugin is available at [http://nanojs.org/plugins/browser](http://nanojs.org/plugins/browser).
31+
32+
Support
33+
-------
34+
35+
For support, bugs and feature requests, please use the [issues](https://github.com/nanojs/nano-browser/issues) section of this repository.
36+
37+
Contributing
38+
------------
39+
40+
If you'd like to contribute new features, enhancements or bug fixes to the code base just follow these steps:
41+
42+
* Create a [GitHub](https://github.com/signup/free) account, if you don't own one already
43+
* Then, [fork](https://help.github.com/articles/fork-a-repo) the [nano-browser](https://github.com/nanojs/nano-browser) repository to your account
44+
* Create a new [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository) from the *develop* branch in your forked repository
45+
* Modify the existing code, or add new code to your branch
46+
* When ready, make a [pull request](http://help.github.com/send-pull-requests/) to the main repository
47+
48+
There may be some discussion regarding your contribution to the repository before any code is merged in, so be prepared to provide feedback on your contribution if required.
49+
50+
License
51+
-------
52+
53+
Copyright 2008-2015 James Watts. All rights reserved.
54+
55+
Licensed under the GNU/GPL. Redistributions of the source code included in this repository must retain the copyright notice found in each file.

0 commit comments

Comments
 (0)