Skip to content

Commit

Permalink
More renamings
Browse files Browse the repository at this point in the history
  • Loading branch information
guillemcordoba committed May 21, 2024
1 parent ef44aa9 commit 2baeb19
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
6 changes: 2 additions & 4 deletions .changes/config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gitSiteUrl": "https://www.github.com/your-org/tauri-plugin-holochain/",
"gitSiteUrl": "https://www.github.com/darksoil-studio/p2p-shipyard/",
"pkgManagers": {
"rust": {
"version": true,
Expand Down Expand Up @@ -82,9 +82,7 @@
"tauri-plugin-holochain-api": {
"path": ".",
"manager": "javascript",
"dependencies": [
"tauri-plugin-holochain"
],
"dependencies": ["tauri-plugin-holochain"],
"releaseTag": "npm-v${ pkgFile.version }"
}
}
Expand Down
6 changes: 3 additions & 3 deletions docs/documentation/how-to-create-a-holochain-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ A **holochain runtime** is an end-user application that is able to install and o
In the repository where you want to create your new holochain runtime, run this command:

```bash
nix run github:darksoil-studio/tauri-plugin-holochain#scaffold-holochain-runtime
nix run github:darksoil-studio/p2p-shipyard#scaffold-holochain-runtime
```

And follow along its instructions and prompts.

2. Take a look into the repository structure that the scaffold command created, specially:

- `flake.nix`: with the `tauri-plugin-holochain` input and its `devShells`.
- `flake.nix`: with the `p2p-shipyard` input and its `devShells`.
- `package.json`: added set up scripts and some `devDependencies`.
- `src-tauri`: here is where the code for the backend of the tauri app lives.
- `src-tauri`: here is where the code for the backend of the tauri app lives. For now it's a simple Tauri app that includes the `tauri-plugin-holochain`.
- `index.html`: main `index.html` file that will be displayed when the app is opened.
- `src`: this is where the code for the UI lives.
- The scaffolded template contains a very bare bones vanilla JS app. Look in `src/main.ts` to see how the frontend for your runtime can connect to the `AdminWebsocket`.
Expand Down
7 changes: 4 additions & 3 deletions docs/documentation/how-to-create-an-end-user-happ.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We need a way to create end-users applications for mobile platforms to create si
1. Run this command inside the repository of your web-hApp:

```bash
nix run github:darksoil-studio/tauri-plugin-holochain#scaffold-tauri-app
nix run github:darksoil-studio/p2p-shipyard#scaffold-tauri-app
```

And follow along to answer all the necessary prompts.
Expand All @@ -30,10 +30,11 @@ This will execute all the required steps to convert your previously scaffolded h

2. Take a look into the files that the scaffold command edited, and adapt them if necessary:

- `flake.nix`: added the `tauri-plugin-holochain` input and its `devShells`.
- `flake.nix`: added the `p2p-shipyard` input and its `devShells`.
- `package.json`: added set up scripts and some `devDependencies`.
- `ui/vite.config.ts`: set the server configuration necessary for tauri.
- `src-tauri`: here is where the code for the backend of the tauri app lives.
- `src-tauri`: here is where the code for the backend of the tauri app lives.
- For now it's a simple Tauri app that includes the `tauri-plugin-holochain`, and installs your app when it's first launched.
- The tauri app will just use the UI that the scaffolding tool produced as its own UI.

> [!WARNING]
Expand Down
6 changes: 3 additions & 3 deletions docs/license/license.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# License

Tauri Plugin Holochain is [Source-Available](https://en.wikipedia.org/wiki/Source-available_software), you can see its source code [here](https://github.com/darksoil-studio/tauri-plugin-holochain). We are raising funds to make it Open Source.
`p2p-shipyard` is [Source-Available](https://en.wikipedia.org/wiki/Source-available_software), you can see its source code [here](https://github.com/darksoil-studio/p2p-shipyard). We are raising funds to make it Open Source.

If you'd like to contribute to `p2p-shipyard` being open-source and free to use by everyone, please go to our open-collective page to contribute!

https://opencollective.com/darksoil/projects/tauri-plugin-holochain
https://opencollective.com/darksoil/projects/p2p-shipyard

Once the goal of the tier "Open-Source it!" is reached, we'll add the Open-Source license to the repository so that everyone can use it, for free.

Expand All @@ -18,4 +18,4 @@ The basic cost of an engagement is 1 ticket. darksoil studio reserves the right

To buy a ticket, go to our open collective page:

https://opencollective.com/darksoil/projects/tauri-plugin-holochain
https://opencollective.com/darksoil/projects/p2p-shipyard

0 comments on commit 2baeb19

Please sign in to comment.