Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesHenry authored Mar 3, 2024
1 parent 7f3ee73 commit 3dc803d
Showing 1 changed file with 5 additions and 44 deletions.
49 changes: 5 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,15 @@
# ReleaseJsAndRust
# Example of publishing Rust Crates and JS packages with `nx release`

<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>

**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 <plugin-name>` 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 <target> <project> <...options>
```

You can also run multiple targets:

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

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

```
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/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!

Expand Down

0 comments on commit 3dc803d

Please sign in to comment.