Skip to content

Commit

Permalink
Better setup page
Browse files Browse the repository at this point in the history
  • Loading branch information
guillemcordoba committed Nov 19, 2024
1 parent da1eae8 commit 5cd3a67
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions crates/scaffold_tnesh_zome/template/docs/setup.md.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,12 @@ nix run github:{{github_organization}}/{{kebab_case zome_name}}-zome#scaffold
```

This will do the following:
- Add the flake input for that repository in your `flake.nix`.
- Add the appropriate zome packages to the `dna.nix` that you select.
- Add the UI package for @{{npm_organization}}/{{kebab_case zome_name}}-zome as a dependency of your UI package.
- Add the `github:{{github_organization}}/{{kebab_case zome_name}}-zome` flake input in your `flake.nix`.
- Add the `{{snake_case zome_name}}` coordinator and integrity zome packages to the `dna.nix` that you select.
- Add the UI package for `@{{npm_organization}}/{{kebab_case zome_name}}-zome` as a dependency of your UI package.
- Add the `<{{kebab_case zome_name}}-context>` element at the top level of your application.

> [!NOTE]
> You can read more about the context pattern [here](https://darksoil.studio/tnesh-stack/guides/custom-elements#context).

That's it! You have now integrated the `linked-devices` coordinator and integrity zomes and their UI into your app!
That's it! You have now integrated the `linked_devices` coordinator and integrity zomes and their UI into your app!

Now, [choose which elements you need](/elements/{{kebab_case zome_name}}-context.md) and import them like this:

Expand Down

0 comments on commit 5cd3a67

Please sign in to comment.