diff --git a/License.md b/LICENSE.md similarity index 100% rename from License.md rename to LICENSE.md diff --git a/README.md b/README.md index a9220fc2c5469b30094692b71a059f0bd1d05d98..d8bfd14c1729b4560692b6d9aa4c121f6ec59d7b 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,93 @@ This directory contains programs to generate FLEXPART WINDFIELDS from ECMWF ERA- Please report any problems. +====================================================================================================== + + + +# license added by me +with url +<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>. + +with pic +<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="/documentation/Sphinx/source/_static/cc-by-40.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>. + + +# Product Name +> Short blurb about what your product does. + +[![NPM Version][npm-image]][npm-url] +[![Build Status][travis-image]][travis-url] +[![Downloads Stats][npm-downloads]][npm-url] + +One to two paragraph statement about your product and what it does. + + + +## Installation + +OS X & Linux: + +```sh +npm install my-crazy-module --save +``` + +Windows: + +```sh +edit autoexec.bat +``` + +## Usage example + +A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots. + +_For more examples and usage, please refer to the [Wiki][wiki]._ + +## Development setup + +Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms. + +```sh +make install +npm test +``` + +## Release History + +* 0.2.1 + * CHANGE: Update docs (module code remains unchanged) +* 0.2.0 + * CHANGE: Remove `setDefaultXYZ()` + * ADD: Add `init()` +* 0.1.1 + * FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!) +* 0.1.0 + * The first proper release + * CHANGE: Rename `foo()` to `bar()` +* 0.0.1 + * Work in progress + +## Meta + +Your Name – [@YourTwitter](https://twitter.com/dbader_org) – YourEmail@example.com + +Distributed under the XYZ license. See ``LICENSE`` for more information. + +[https://github.com/yourname/github-link](https://github.com/dbader/) + +## Contributing + +1. Fork it (<https://github.com/yourname/yourproject/fork>) +2. Create your feature branch (`git checkout -b feature/fooBar`) +3. Commit your changes (`git commit -am 'Add some fooBar'`) +4. Push to the branch (`git push origin feature/fooBar`) +5. Create a new Pull Request + +<!-- Markdown link & img dfn's --> +[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square +[npm-url]: https://npmjs.org/package/datadog-metrics +[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square +[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square +[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics +[wiki]: https://github.com/yourname/yourproject/wiki