diff --git a/README.md b/README.md index d835e03..d6438cc 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,15 @@ -# ReleaseJsAndRust +# Example of publishing Rust Crates and JS packages with `nx release` ✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨ -## Generate code +## Read the guides on nx.dev -If you happen to use Nx plugins, you can leverage code generators that might come with it. +- The getting started guide for `nx release` can be found here: https://nx.dev/recipes/nx-release/get-started-with-nx-release +- The additional recipe for publishing Rust Crates can be found here: https://nx.dev/recipes/nx-release/publish-rust-crates -Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list ` to see what generators are available. - -Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators). - -## Running tasks - -To execute tasks with Nx use the following syntax: - -``` -nx <...options> -``` - -You can also run multiple targets: - -``` -nx run-many -t -``` - -..or add `-p` to filter specific projects - -``` -nx run-many -t -p -``` - -Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks). - -## Want better Editor Integration? - -Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users. - -## Ready to deploy? - -Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed. - -## 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/core-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) +This repo demonstrates how both Rust Crates and JS packages can be combined and released from a single Nx workspace. ## Connect with us!