Merge pull request #682 from mkszepp/fix-readme-licence

Readd/update readme / license

LICENSE.md

@@ -1,9 +1 @@
-The MIT License (MIT)
-
-Copyright (c) 2023
-
-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.
+liquid-fire/LICENSE.md

README.md

@@ -1,26 +1 @@
-# liquid-fire
-
-[Short description of the addon.]
-
-## Compatibility
-
-- Ember.js v3.28 or above
-- Embroider or ember-auto-import v2
-
-## Installation
-
-```
-ember install liquid-fire
-```
-
-## Usage
-
-[Longer description of how to use the addon in apps.]
-
-## Contributing
-
-See the [Contributing](CONTRIBUTING.md) guide for details.
-
-## License
-
-This project is licensed under the [MIT License](LICENSE.md).
+liquid-fire/README.md

liquid-fire/.gitignore

@@ -1,5 +1,30 @@
-# The authoritative copies of these live in the monorepo root (because they're
-# more useful on github that way), but the build copies them into here so they
-# will also appear in published NPM packages.
-/README.md
-/LICENSE.md
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+/node_modules/
+
+# misc
+/.env*
+/.eslintcache
+/.pnp*
+/.sass-cache
+/.eslintcache
+/connect.lock
+/coverage/
+/libpeerconnection.log
+/npm-debug.log*
+/testem.log
+/yarn-error.log
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/npm-shrinkwrap.json.ember-try
+/package.json.ember-try
+/package-lock.json.ember-try
+/yarn.lock.ember-try

liquid-fire/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019
+
+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.

liquid-fire/README.md

@@ -0,0 +1,67 @@
+# Liquid Fire
+
+Comprehensive animation support for ambitious Ember applications. [Interactive Documentation is here](http://ember-animation.github.io/liquid-fire/).
+
+## Features
+
+- Animated transitions between routes that work seamlessly with the
+  Ember router.
+
+- A DSL for laying out your spatial route relationships, cleanly
+  separated from view-layer implementation details.
+
+- Animated transitions between models within a single route.
+
+- Animated transitions between individual scalar values within a
+  template.
+
+- Promise-driven API to control your animation flow.
+
+- Backed by velocity.js, but easy to extend to other animation drivers
+  if there's interest.
+
+## Documentation
+
+[Liquid Fire website](http://ember-animation.github.io/liquid-fire) is an ember-cli application that contains an
+interactive demo & documentation. It runs from Liquid Fire's [test dummy app](https://github.com/ember-animation/liquid-fire/tree/master/tests/dummy/app).
+
+You can also see some examples in my [Ember Animation Demo](http://github.com/ef4/ember-animation-demo) repo, and this [video presentation from the Boston Ember Meetup](https://www.youtube.com/watch?v=S4M78SO3gAc).
+
+### Ember Compatibility Table
+
+The latest version of Liquid Fire is tested with Ember versions as far back as 4.0.
+
+For older versions, see [this wiki page](https://github.com/ember-animation/liquid-fire/wiki/Compatibility-Table,-Old-Versions).
+
+## Development
+
+### Source Organization
+
+This repo contains both the liquid-fire library and a demo application
+that presents interactive documentation. It follows standard ember-cli
+addon v2 format.
+
+- liquid-fire: is code that can be imported by the user from the `liquid-fire` namespace
+- docs: is the demo and documentation application
+- test-app: is the testing
+
+## Testing
+
+When running tests you'll want to set your transition speeds to 0 so they don't slow down your tests. This can be accomplished by using an Environment variable.
+
+```javascript
+// Import the Environment
+import ENV from "your-application-name/config/environment";
+
+// If Testing Environment
+if (ENV.environment === "test") {
+  var customDuration = 0; // set to 0 seconds
+} else {
+  var customDuration = 200; // set to 200 miliseconds
+}
+
+this.transition(
+  this.toRoute("foo"),
+  this.use("toLeft", { duration: customDuration }) // Use customDuration
+);
+```