Add and tweak READMEs

README.md

@@ -1,10 +1,23 @@
 # ember-headless-form
 
-[Short description of the addon.]
+[![CI](https://github.com/CrowdStrike/ember-headless-form/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/CrowdStrike/ember-headless-form/actions/workflows/ci.yml)
+
+The Ember.js addon that distills the common behavior and accessibility best practices of forms into reusable components, without any opinions on specific markup or styling. Use it to build your forms directly, or to build your opinionated forms component kit on top of it.
+
+## Key Features
+
+- Semantic form markup with accessibility best practices baked in
+- Integrates native HTML5 validation with custom error rendering
+- Extension points for custom JavaScript-based validation
+- Optional ready-to-use integrations for `ember-changeset` and `yup` based validation
+- Support for async state
+- TypeScript / Glint support with tight types
+- Octane-based v2 addon
+- Fully tested
 
 ## Compatibility
 
-- Ember.js v4.8 or above
+- Ember.js v4.4 or above
 - Embroider or ember-auto-import v2
 
 ## Installation
@@ -15,7 +28,7 @@ ember install ember-headless-form
 
 ## Usage
 
-[Longer description of how to use the addon in apps.]
+Visit our [documentation website](https://ember-headless-form.pages.dev/).
 
 ## Contributing
 

packages/changeset/.gitignore

@@ -1,5 +1,4 @@
 # 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

packages/changeset/README.md

@@ -0,0 +1,26 @@
+# ember-headless-form-changeset
+
+Integrates [`ember-changeset`](https://github.com/poteto/ember-changeset) and optionally [`ember-changeset-validations`](https://github.com/poteto/ember-changeset-validations/) seamlessly with the validation support of [ember-headless-form](https://github.com/CrowdStrike/ember-headless-form).
+
+## Compatibility
+
+- Ember.js v4.4 or above
+- Embroider or ember-auto-import v2
+
+## Installation
+
+```
+ember install ember-headless-form-changeset
+```
+
+## Usage
+
+Visit our [documentation website](https://ember-headless-form.pages.dev/).
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

packages/changeset/rollup.config.mjs

@@ -50,10 +50,7 @@ export default {
 
     // Copy Readme and License into published package
     copy({
-      targets: [
-        { src: '../README.md', dest: '.' },
-        { src: '../LICENSE.md', dest: '.' },
-      ],
+      targets: [{ src: '../../LICENSE.md', dest: '.' }],
     }),
   ],
 };

packages/ember-headless-form/rollup.config.mjs

@@ -51,8 +51,8 @@ export default {
     // Copy Readme and License into published package
     copy({
       targets: [
-        { src: '../README.md', dest: '.' },
-        { src: '../LICENSE.md', dest: '.' },
+        { src: '../../README.md', dest: '.' },
+        { src: '../../LICENSE.md', dest: '.' },
       ],
     }),
   ],

packages/yup/.gitignore

@@ -1,5 +1,4 @@
 # 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

packages/yup/README.md

@@ -0,0 +1,26 @@
+# ember-headless-form-yup
+
+Integrates [`yup`](https://github.com/jquense/yup) based schemas seamlessly with the validation support of [ember-headless-form](https://github.com/CrowdStrike/ember-headless-form).
+
+## Compatibility
+
+- Ember.js v4.4 or above
+- Embroider or ember-auto-import v2
+
+## Installation
+
+```
+ember install ember-headless-form-yup
+```
+
+## Usage
+
+Visit our [documentation website](https://ember-headless-form.pages.dev/).
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

packages/yup/rollup.config.mjs

@@ -50,10 +50,7 @@ export default {
 
     // Copy Readme and License into published package
     copy({
-      targets: [
-        { src: '../README.md', dest: '.' },
-        { src: '../LICENSE.md', dest: '.' },
-      ],
+      targets: [{ src: '../../LICENSE.md', dest: '.' }],
     }),
   ],
 };