diff --git a/README.md b/README.md index 7471567..ae34f42 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Sketch +# ngSketch - +ngSketch is an open-source headless library for Angular 18+. It peppers your application with UI functionality but keeps it free of styled dependencies. ngSketch only uses Angular CDK as a dependency, which is also completely unstyled. -✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨ +Get inspired by opinionated demos and use the theme that fits your application. ## Storybook @@ -10,12 +10,6 @@ Deployed from main: https://661d194a3f6d14d86c328554-yfvvdffiwi.chromatic.com/ Chromatic app: https://www.chromatic.com/builds?appId=661d194a3f6d14d86c328554 -## Integrate with editors - -Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console -provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and -comes with a LSP for Vim users. - ## Start the application Run `npx nx serve sketch` to start the development server. Happy coding! @@ -24,45 +18,6 @@ Run `npx nx serve sketch` to start the development server. Happy coding! Run `npx nx build sketch` to build the application. The build artifacts are stored in the output directory (e.g. `dist/` or `build/`), ready to be deployed. -## Running tasks - -To execute tasks with Nx use the following syntax: - -``` -npx nx <...options> -``` - -You can also run multiple targets: - -``` -npx nx run-many -t -``` - -..or add `-p` to filter specific projects - -``` -npx nx run-many -t -p -``` - -Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks). - -## Set up CI! - -Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further. - -- [Set up remote caching](https://nx.dev/features/share-your-cache) -- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) -- [Learn more how to setup CI](https://nx.dev/recipes/ci) - -## Explore the project graph - -Run `npx nx graph` to show the graph of the workspace. -It will show tasks that you can run with Nx. - -- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) - -## Connect with us! +## License -- [Join the community](https://nx.dev/community) -- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools) -- [Follow us on Twitter](https://twitter.com/nxdevtools) +ngSketch is licensed under **MIT**. For more information, please see [LICENSE](/LICENSE)