From e3e6fd1fb20aee4c54d0a338d1b4169ffc33fee8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20M=C3=BCller?= Date: Wed, 26 Jun 2024 09:48:12 +0200 Subject: [PATCH 1/2] feat: add MIT license --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..12fbdb8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2024 qupaya technologies GmbH. https://qupaya.com + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file From a846708a946fbc4d399b985648baa49ce47e48dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20M=C3=BCller?= Date: Wed, 26 Jun 2024 10:13:34 +0200 Subject: [PATCH 2/2] docs: update readme with minimal information --- README.md | 55 +++++-------------------------------------------------- 1 file changed, 5 insertions(+), 50 deletions(-) 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)