@codetectonics/mantle 0.0.2 → 0.0.4

package/README.md

@@ -1,63 +1,24 @@
 # Mantle
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.0.
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.1.0.
 
 ## Code scaffolding
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+Run `ng generate component component-name --project mantle` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project mantle`.
+> Note: Don't forget to add `--project mantle` or else it will be added to the default project in your `angular.json` file. 
 
-```bash
-ng generate component component-name
-```
+## Build
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+Run `ng build mantle` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-```bash
-ng generate --help
-```
+## Publishing
 
-## Building
-
-To build the library, run:
-
-```bash
-ng build mantle
-```
-
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
-
-### Publishing the Library
-
-Once the project is built, you can publish your library by following these steps:
-
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/mantle
-   ```
-
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+After building your library with `ng build mantle`, go to the dist folder `cd dist/mantle` and run `npm publish`.
 
 ## Running unit tests
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
-```
-
-## Running end-to-end tests
-
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
-```
-
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+Run `ng test mantle` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## Additional Resources
+## Further help
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.