diff --git a/chat-app-1.png b/assets/chat-app-1.png similarity index 100% rename from chat-app-1.png rename to assets/chat-app-1.png diff --git a/chat-app-2.png b/assets/chat-app-2.png similarity index 100% rename from chat-app-2.png rename to assets/chat-app-2.png diff --git a/chat-app-3.png b/assets/chat-app-3.png similarity index 100% rename from chat-app-3.png rename to assets/chat-app-3.png diff --git a/chat-app-4.png b/assets/chat-app-4.png similarity index 100% rename from chat-app-4.png rename to assets/chat-app-4.png diff --git a/chat-app-5.png b/assets/chat-app-5.png similarity index 100% rename from chat-app-5.png rename to assets/chat-app-5.png diff --git a/chat-app-6.png b/assets/chat-app-6.png similarity index 100% rename from chat-app-6.png rename to assets/chat-app-6.png diff --git a/chat-app-7.png b/assets/chat-app-7.png similarity index 100% rename from chat-app-7.png rename to assets/chat-app-7.png diff --git a/chat-app-8.png b/assets/chat-app-8.png similarity index 100% rename from chat-app-8.png rename to assets/chat-app-8.png diff --git a/getting-started.md b/getting-started.md deleted file mode 100644 index 49add89..0000000 --- a/getting-started.md +++ /dev/null @@ -1,46 +0,0 @@ -# Getting Started with Pear - -## Requirements - -Pear runs on Windows, Mac and Linux. - -The `pear` CLI can be installed from [npm](https://www.npmjs.com/), which comes with [`node`](https://nodejs.org/en/about). - -The `npm` package manager can also be used to install application dependencies later on. - -On MacOS and Linux, we recommend installing `node` using [`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating) - -On Windows we recommend installing `node` with [`nvs`](https://github.com/jasongin/nvs#setup). - -> Info: The Pear Runtime does not rely on `node`, `node` is only needed to install and run the `npm` package manager. - -## Setup - -To install Pear run the following command: - -```sh -npm i -g pear -``` - -To complete the setup, run the `pear` command. - -``` -pear -``` - -If a Pear application, such as [Keet](https://keet.io), is already installed then the Pear platform is already available. In this case, running `pear` should show help output. - -If not, the first run of `pear` will fetch the platform from peers, after which running `pear` again should output help information. - -To check that Pear is fully working, try the following command: - -``` -pear launch keet -``` - -Pear loads applications from peers, so this command should launch [Keet](https://keet.io) whether or not it was downloaded and installed beforehand. - - -## Next - -* [Making a Pear App](./making-a-pear-app.md) \ No newline at end of file diff --git a/making-a-pear-app-1.md b/guides/making-a-pear-app-1.md similarity index 96% rename from making-a-pear-app-1.md rename to guides/making-a-pear-app-1.md index 2095098..ff12eb7 100644 --- a/making-a-pear-app-1.md +++ b/guides/making-a-pear-app-1.md @@ -31,7 +31,7 @@ $ pear dev This will open the app. Because it's opened in development mode, developer tools are also opened. -![Running pear dev](/chat-app-1.png) +![Running pear dev](../assets/chat-app-1.png) ## Step 3. Automatic reload @@ -39,7 +39,7 @@ Pear apps have automatic reload included. This means that there is no need to st While keeping the app open with `pear dev`, open `index.html` in a code editor. Change `

chat

` to `

Hello world

` and go to the app again. It should now look like this: -![Automatic reload](/chat-app-2.png) +![Automatic reload](../assets/chat-app-2.png) ## Step 4. Install modules @@ -151,7 +151,7 @@ In this first version, users are able to create a chat room or join others. Then After running with `pear dev` it should look like this: -![Layout of the app](/chat-app-3.png) +![Layout of the app](../assets/chat-app-3.png) ## Step 6. Write the javascript code, using `hyperswarm` @@ -243,11 +243,11 @@ In the first app, click on `Create chat room`. When it has started the topic is In the second app, paste in the topic that was shown in the first app, and then click on `Join chat room`. -![Use topic from creator](/chat-app-4.png) +![Use topic from creator](../assets/chat-app-4.png) After that the two apps are able to send messages between them -![Messages between the peers](/chat-app-5.png) +![Messages between the peers](../assets/chat-app-5.png) ## Understanding the code @@ -317,7 +317,7 @@ And now the app should run. **Note**: The process can be that runs `pear seed main` can now be exited, and while at least one computer is running the app, others will still be able to launch it using the key from before. This is because that any user of the app also helps seeding it. -![Launching the app with pear launch](/chat-app-6.png) +![Launching the app with pear launch](../assets/chat-app-6.png) ## Learnings, main takeaways @@ -333,4 +333,4 @@ That is it for the first version of the chat app. Users can create and join room In the next part, let's add a nickname to all users, and the ability for them to change it. -[Go to next tutorial](/making-a-pear-app-2.md) +[Go to next tutorial](../assets/making-a-pear-app-2.md) diff --git a/making-a-pear-app-2.md b/guides/making-a-pear-app-2.md similarity index 100% rename from making-a-pear-app-2.md rename to guides/making-a-pear-app-2.md diff --git a/releasing-a-pear-app.md b/releasing-a-pear-app.md deleted file mode 100644 index 775d4e0..0000000 --- a/releasing-a-pear-app.md +++ /dev/null @@ -1,6 +0,0 @@ -* pear release -* staged vs release - * use of --checkout flag -* rollback -* internal release -> dump -> public release -* building \ No newline at end of file diff --git a/sharing-a-pear-app.md b/sharing-a-pear-app.md deleted file mode 100644 index 6030584..0000000 --- a/sharing-a-pear-app.md +++ /dev/null @@ -1,2 +0,0 @@ -* pear stage -* pear launch