aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 22:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixup

Browse Source
This commit is contained in:
David Mark Clements
2023-12-07 17:59:24 +01:00
parent 3aa08f0da5
commit d443d01b9e
7 changed files with 65 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -16,6 +16,7 @@ Welcome to the Internet of Peers
### Guide
* [Getting Started](./guide/getting-started.md)
* [Starting a Pear App](./guide/starting-a-pear-app.md)
* [Making a Pear App](./guide/making-a-pear-app.md)
* [Sharing a Pear App](./guide/sharing-a-pear-app.md)
* [Releasing a Pear App](./guide/releasing-a-pear-app.md)

0
guides/making-a-pear-app.md → guide/making-a-pear-app.md
View File

19
guide/releasing-a-pear-app.md
View File

@@ -1,6 +1,13 @@
* pear release
* staged vs release
* use of --checkout flag
* rollback
* internal release -> dump -> public release
* building
# Releasing a Pear App
As covered in [Sharing a Pear App](./sharing-a-pear-app.md), Pear use release channels in a similar way that git use branches. When the app has been tested, and it's ready to release it, it's really simple.
## Step 1. Releasing
Assume that the app was staged into `example`, then releasing it is simply:
```
$ pear release example
```
This moves the example channel to the released version. The seeders who are already seeding that channel, will still be seeding.

53
guide/sharing-a-pear-app.md
View File

@@ -1,2 +1,51 @@
* pear stage
* pear launch
# Sharing a Pear App
Before releasing a Pear app to the public, it's possible to share it with others.
With Pear there are one single "release" (or "production") version of an app, and then many other named versions. Think of it, the same way that `git` use branches. Code is put into channels. This way others can test it, and when everything is ready, that branch is pulled into the release channel.
To share apps, stage them using `pear stage some-name`. This builds a new version of the app and puts them into the `some-name` channel.
## Step 1. Staging
Before sharing the app, first stage it into a channel called `example` (the name can be anything)
```
$ pear stage example
```
## Step 2. Seeding
After the app has been staged into the `example` channel, it now needs to be seeded. This is a way to signal that the app is now shared, so others can download and run it.
```$ pear seed example
🍐 Seeding: chat [ example ]
ctrl^c to stop & exit
-o-:-
pear:nykmkrpwgadcd8m9x5khhh43j9izj123eguzqg3ygta7yn1s379o
...
^_^ announced
```
For now, keep this terminal open. As long as this process is running, your computer will help seed the application.
## Step 3. Launching
Because the app is now being seeded, it' possible for others with the key (`pear:nykm...`) to launch it.
In another terminal (or on another computer), run:
```
$ pear launch pear:nykmkrpwgadcd8m9x5khhh43j9izj123eguzqg3ygta7yn1s379o
```
This will download and open the app.
Note: Anyone running the app also help to seed it. So if the app had a lot of users, the original seeder could close down the process.
## Next
The app is shared and others can now run it on their machines. To learn how a more production-ready setup would look like read [releasing a Pear App](./releasing-a-pear-app.md).

0
guides/starting-a-pear-app.md → guide/starting-a-pear-app.md
View File

13
guides/releasing-a-pear-app.md
View File

@@ -1,13 +0,0 @@
# Releasing a Pear App
As covered in [Sharing a Pear App](./sharing-a-pear-app.md), Pear use release channels in a similar way that git use branches. When the app has been tested, and it's ready to release it, it's really simple.
## Step 1. Releasing
Assume that the app was staged into `example`, then releasing it is simply:
```
$ pear release example
```
This moves the example channel to the released version. The seeders who are already seeding that channel, will still be seeding.

51
guides/sharing-a-pear-app.md
View File

@@ -1,51 +0,0 @@
# Sharing a Pear App
Before releasing a Pear app to the public, it's possible to share it with others.
With Pear there are one single "release" (or "production") version of an app, and then many other named versions. Think of it, the same way that `git` use branches. Code is put into channels. This way others can test it, and when everything is ready, that branch is pulled into the release channel.
To share apps, stage them using `pear stage some-name`. This builds a new version of the app and puts them into the `some-name` channel.
## Step 1. Staging
Before sharing the app, first stage it into a channel called `example` (the name can be anything)
```
$ pear stage example
```
## Step 2. Seeding
After the app has been staged into the `example` channel, it now needs to be seeded. This is a way to signal that the app is now shared, so others can download and run it.
```$ pear seed example
🍐 Seeding: chat [ example ]
ctrl^c to stop & exit
-o-:-
pear:nykmkrpwgadcd8m9x5khhh43j9izj123eguzqg3ygta7yn1s379o
...
^_^ announced
```
For now, keep this terminal open. As long as this process is running, your computer will help seed the application.
## Step 3. Launching
Because the app is now being seeded, it' possible for others with the key (`pear:nykm...`) to launch it.
In another terminal (or on another computer), run:
```
$ pear launch pear:nykmkrpwgadcd8m9x5khhh43j9izj123eguzqg3ygta7yn1s379o
```
This will download and open the app.
Note: Anyone running the app also help to seed it. So if the app had a lot of users, the original seeder could close down the process.
## Next
The app is shared and others can now run it on their machines. To learn how a more production-ready setup would look like read [releasing a Pear App](./releasing-a-pear-app.md).