From c3bf1e548156f83d5c1513e3106d81aa14e90419 Mon Sep 17 00:00:00 2001
From: Sam Van Campenhout <sam.van.campenhout@gmail.com>
Date: Tue, 10 Oct 2023 14:27:20 +0200
Subject: [PATCH] Update the readme and contributing files

Some of the information was out-of-date and we now also link to the template-tag authoring format documentation to get people started faster.
---
 CONTRIBUTING.md |  9 ++++-----
 README.md       | 31 +++++++++++++++++++++----------
 2 files changed, 25 insertions(+), 15 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 35adc2598..76f55c92f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -28,7 +28,7 @@
 
 - `git clone <repository-url>`
 - `cd ember-appuniversum`
-- `npm install` (use npm 6 until we drop node 14 support)
+- `npm install`
 
 ### Linting
 
@@ -37,13 +37,12 @@
 
 ### 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
+- start the development server `npm run ember` and go to the `/tests` route
+- `npm run test:ember` – Runs the test suite on the current Ember version
 
 ### Running the dummy application
 
 - `npm start`
-- Visit the storybook application at [http://localhost:6006](http://localhost:4200).
+- Visit the storybook application at [http://localhost:6006](http://localhost:6006).
 
 For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
diff --git a/README.md b/README.md
index 896a70148..9ba7ce5bf 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # @appuniversum/ember-appuniversum
 
-Ember addon wrapping [the appuniversum components](https://appuniversum.github.io/ember-appuniversum/).
+Ember addon that provides components for Flanders themed applications.
 
 ## Compatibility
 
@@ -11,12 +11,12 @@ Ember addon wrapping [the appuniversum components](https://appuniversum.github.i
 ## Installation
 
 ```
-ember install @appuniversum/ember-appuniversum
+npm install --save-dev @appuniversum/ember-appuniversum
 ```
 
 ## Usage
 
-This ember addon wraps a CSS framework for Flanders government applications called appuniversum. It provides components that helps being complient with this framework in Ember apps.
+This ember addon wraps a CSS framework for Flanders government applications called Appuniversum. It provides components that helps being compliant with this framework in Ember apps.
 
 ## Contributing
 
@@ -24,25 +24,36 @@ See the [Contributing](CONTRIBUTING.md) guide for details.
 
 ## Development
 
-Local development:
+### Running the local development setup
 
-- Build the ember app: `npm run ember`
+- Start the ember app: `npm run ember`
 - Run the documentation site: `npm run storybook` (make sure the `npm run ember` command is finished)
 - Generate the icons: `npm run icons`
 
-Testing:
+> We use the "template tag" (.gjs) format for component authoring which has been described in detail in the [RFC](https://github.com/emberjs/rfcs/blob/master/text/0779-first-class-component-templates.md).
+> A summarized version can be found in the ember-template-imports library which also has some information about [how to setup your dev environment](https://github.com/ember-template-imports/ember-template-imports#editor-integrations) for a better experience.
 
-- PR previews and testing is available on [Chromatic](https://www.chromatic.com/build?appId=61e5835e5fbce3003a653ee6)
+### Testing:
 
-Releases:
+- the `/tests` route allows you to run the tests in your browser.
+- Specific ember-try scenarios can be run if you want to debug them locally: `npx ember try:one scenario-name`. `--skip-cleanup` can be used to debug the scenario from the `/tests` route
+- PR previews and testing is available on [Chromatic](https://www.chromatic.com/build?appId=61e5835e5fbce3003a653ee6)
 
-- Release to npm: `npm run release`
+### Testing changes in apps
 
-Link to an ember project:
+#### npm link
 
 - In the addon: `npm link`
 - In the your project: `npm link @appuniversum/ember-appuniversum`
 
+#### yalc
+
+[yalc](https://github.com/wclr/yalc) is a good alternative if the npm link setup doesn't work as expected.
+
+### Releases:
+
+Release to npm: `GITHUB_AUTH=your-token npm run release` and follow the prompts
+
 ## License
 
 This project is licensed under the [MIT License](LICENSE.md).