Browse Source

update readme

Paul Frazee 4 years ago
parent
commit
a9cb99dc44
2 changed files with 23 additions and 11 deletions
  1. 23
    11
      README.md
  2. BIN
      screenshot.png

+ 23
- 11
README.md View File

@@ -1,33 +1,45 @@
1 1
 # Patchwork
2 2
 
3
-**Patchwork is in active development. <a href="http://ssbc.github.io/">Sign up for our mailing list</a>, and we'll notify you when it's ready to use.**
3
+![screenshot](./screenshot.png)
4 4
 
5
-Patchwork is a peer-to-peer network for sharing social feeds and open-source software. It gives you freedom to meet and collaborate online without surrendering ownership of your data.
5
+Patchwork is a peer-to-peer application for sharing social feeds.
6 6
 
7
-Patchwork isn't a website: it runs on your computer and syncs over the Internet or WiFi. User-tracking and advertisements are actively prevented, and user applications are fully supported.
7
+Patchwork isn't a website: it runs on your computer and syncs over the Internet or WiFi.
8
+User-tracking and advertisements are actively prevented.
8 9
 
9
-<a href="http://ssbc.github.io/">Learn more</a>
10
+![Hermies the Hermit Crab](https://avatars2.githubusercontent.com/u/10190339?v=3&s=200)
11
+
12
+[Built with Secure Scuttlebutt](https://github.com/ssbc/docs)
10 13
 
11 14
 
12 15
 ## Running Patchwork
13 16
 
14
-**Dependencies:**
17
+Current install steps are:
15 18
 
16 19
 ```
17
-# Linux dependencies
18
-apt-get install automake
20
+# ubuntu
21
+apt-get install automake libtool
22
+# osx
23
+brew install automake libtool
24
+```
19 25
 
20
-# OSX dependencies
21
-brew install automake
26
+Also, you'll need to use iojs@2.
27
+The easiest way to get this is [nvm](https://github.com/creationix/nvm).
28
+
29
+```
30
+nvm install iojs-v2.5.0
22 31
 ```
23 32
 
33
+Then, install the software:
34
+
24 35
 ```
36
+git clone https://github.com/ssbc/patchwork.git
37
+cd patchwork
25 38
 npm install
26 39
 npm start
27 40
 ```
28 41
 
29
-**Start connecting by joining a pub server**
30
-
42
+And then join a pub server.
31 43
 Check out the list of active servers [here](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers)
32 44
 
33 45
 

BIN
screenshot.png View File


Loading…
Cancel
Save