grunt-init grunt-init-commonjs --force

README.md

@@ -1,6 +1,57 @@
-#Gragir.JS
-Gragir (Armenian: գրագիր) - per google translate: writer.
-գիր (gir) - from Old Armenian գիր (gir). From Proto-Indo-European *wēr-, from *wer- (“to cut, scratch, tear, sketch an outline”).
-
-This is an experimental javascript library to generate EPUB v3 books right
-from the browser.
+# gragir.js
+
+EPUB v3 generator.
+
+## Getting Started
+### On the server
+Install the module with: `npm install gragir.js`
+
+```javascript
+var gragir_js = require('gragir.js');
+gragir_js.awesome(); // "awesome"
+```
+
+### In the browser
+Download the [production version][min] or the [development version][max].
+
+[min]: https://raw.github.com/KhachatryanVahagn/gragir.js/master/dist/gragir.js.min.js
+[max]: https://raw.github.com/KhachatryanVahagn/gragir.js/master/dist/gragir.js.js
+
+In your web page:
+
+```html
+<script src="dist/gragir.js.min.js"></script>
+<script>
+awesome(); // "awesome"
+</script>
+```
+
+In your code, you can attach gragir.js's methods to any object.
+
+```html
+<script>
+var exports = Bocoup.utils;
+</script>
+<script src="dist/gragir.js.min.js"></script>
+<script>
+Bocoup.utils.awesome(); // "awesome"
+</script>
+```
+
+## Documentation
+_(Coming soon)_
+
+## Examples
+_(Coming soon)_
+
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
+
+_Also, please don't edit files in the "dist" subdirectory as they are generated via Grunt. You'll find source code in the "lib" subdirectory!_
+
+## Release History
+_(Nothing yet)_
+
+## License
+Copyright (c) 2018 Vahagn Khachatryan  
+Licensed under the MIT license.