Skip to content

Commit

Permalink
docs: update readme with minimal information
Browse files Browse the repository at this point in the history
  • Loading branch information
BaggersIO committed Jun 26, 2024
1 parent df62a21 commit 5abc702
Showing 1 changed file with 5 additions and 50 deletions.
55 changes: 5 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
# Sketch
# ngSketch

<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
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

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!
Expand All @@ -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 <target> <project> <...options>
```

You can also run multiple targets:

```
npx nx run-many -t <target1> <target2>
```

..or add `-p` to filter specific projects

```
npx nx run-many -t <target1> <target2> -p <proj1> <proj2>
```

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)

0 comments on commit 5abc702

Please sign in to comment.