Merge pull request #365 from nickschot/move-readme-etc

Move README, CONTRIBUTING and LICENSE.md to addon folder

CONTRIBUTING.md

@@ -0,0 +1 @@
+./addon/CONTRIBUTING.md

LICENSE.md

@@ -0,0 +1 @@
+./addon/LICENSE.md

README.md

@@ -0,0 +1 @@
+./addon/README.md

addon/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# How To Contribute
+
+## Installation
+
+* `git clone <repository-url>`
+* `cd ember-mobile-menu`
+* `pnpm install`
+
+## Linting
+
+* `pnpm lint`
+* `pnpm lint:fix`
+
+## Running tests
+
+* `ember test` – Runs the test suite on the current Ember version
+* `ember test --server` – Runs the test suite in "watch mode"
+* `ember try:each` – Runs the test suite against multiple Ember versions
+
+## Running the dummy application
+
+* `ember serve`
+* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
+
+For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).

addon/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

addon/README.md

@@ -0,0 +1,40 @@
+ember-mobile-menu
+==============================================================================
+
+[![Build Status](https://travis-ci.org/nickschot/ember-mobile-menu.svg?branch=master)](https://travis-ci.org/nickschot/ember-mobile-menu) [![Ember Observer Score](https://emberobserver.com/badges/ember-mobile-menu.svg)](https://emberobserver.com/addons/ember-mobile-menu)
+
+An [ember-cli](http://www.ember-cli.com) addon providing a draggable sidebar specifically tailored to mobile devices.
+
+Both a left and a right menu are supported. Dragging is supported through touch events as supported by any modern (mobile) browser. The sidebar provides an empty canvas suitable for any content.
+
+Requirements
+------------------------------------------------------------------------------
+* Ember.js v3.24 or above
+* Ember CLI v3.12 or above
+* Node.js v14 or above
+* ember-cli-babel v7.23 or above
+* ember-concurrency v2.x
+* ember-auto-import v2.x
+
+**NOTE:** This addon utilizes ResizeObservers. If you require support for older browser you can install a ResizeObserver polyfill like [ember-resize-observer-polyfill](https://github.com/PrecisionNutrition/ember-resize-observer-polyfill).
+
+Installation
+------------------------------------------------------------------------------
+
+From your application directory run: 
+
+`ember install ember-mobile-menu`
+
+Documentation
+------------------------------------------------------------------------------
+https://nickschot.github.io/ember-mobile-menu
+
+Contributing
+------------------------------------------------------------------------------
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+Copyright and license
+------------------------------------------------------------------------------
+
+Code and documentation copyright 2018 Nick Schot. The code is released under [the MIT license](LICENSE.md).