name update; add docs

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 ## Installation
 
 * `git clone <repository-url>`
-* `cd ember-validation-decorator`
+* `cd ember-validation-state`
 * `npm install`
 
 ## Linting

README.md

@@ -1,38 +1,67 @@
-ember-validation-decorator
-==============================================================================
+# `ember-validation-state`
 
-[Short description of the addon.]
+Provides an Octane-ready decorator which can be used in conjunction with ember-validation validators, to provide form field validation state.
 
+This addon takes heavy inspiration, and is based mostly upon, the work in [`ember-cp-validations`](https://github.com/offirgolan/ember-cp-validations), but with a more straightforward approach, and smaller API.
 
-Compatibility
-------------------------------------------------------------------------------
+
+## Compatibility
 
 * Ember.js v3.12 or above
 * Ember CLI v2.13 or above
 * Node.js v10 or above
 
 
-Installation
-------------------------------------------------------------------------------
+## Installation
 
 ```
-ember install ember-validation-decorator
+ember install ember-validation-state
 ```
 
 
-Usage
-------------------------------------------------------------------------------
+## Usage
+
+```js
+import validationState, { validate } from 'ember-validation-state';
+
+const Validators = {
+  username: [validate('presence', { presence: true })],
+  password: [validate('length', { min: 6 })]
+};
+
+class MyForm extends Component {
+  @tracked username = null;
+  @tracked password = null;
+
+  @validationState(Validators) validationState;
+}
+```
 
-[Longer description of how to use the addon in apps.]
+### ValidationState type definition
 
+```ts
+interface AttributeValidation {
+  messages: string[];
+  isValid: boolean;
+}
+
+interface Attrs {
+  [propertyName: string]: AttributeValidation;
+}
+
+interface ValidationState {
+  isValid: boolean;
+  attrs: Attrs
+}
+```
+
+## Contributing
 
-Contributing
-------------------------------------------------------------------------------
 
 See the [Contributing](CONTRIBUTING.md) guide for details.
 
 
-License
-------------------------------------------------------------------------------
+## License
+
 
 This project is licensed under the [MIT License](LICENSE.md).

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "ember-validation-decorator",
+  "name": "ember-validation-state",
   "version": "0.0.0",
   "description": "The default blueprint for ember-cli addons.",
   "keywords": [