Skip to content
This repository was archived by the owner on Jan 7, 2020. It is now read-only.

Commit cfab8aa

Browse files
author
Viv Rajkumar
committed
Merge pull request #34 from krishnaIndia/readme_update
Readme update
2 parents 4849fc8 + 44d11b3 commit cfab8aa

File tree

3 files changed

+89
-14
lines changed

3 files changed

+89
-14
lines changed

‎README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# safe_examples
22
Examples showcasing various features of the SAFE Network
33

4-
## dns_example (NodeJS)
5-
[dns_example](dns_example), written in `NodeJS`, demonstrates the usage of a few NFS and DNS operations.
4+
## demo_app (NodeJS)
5+
[demo_app](demo_app), written in `NodeJS`, demonstrates key features exposed by the SAFE Network.
6+
7+
## dns_example (NodeJS) [Not compatible with the New launcher]
8+
[dns_example](dns_example), written in `NodeJS`, demonstrates the usage of a few NFS and DNS operations.
69
Using the application a simple website can be hosted in the SAFE Network
710

8-
## nfs_example (Rust)
9-
[nfs_example](nfs_example), written in `Rust`, demonstrates the usage of NFS read and write operations.
11+
## nfs_example (Rust) [Not compatible with the New launcher]
12+
[nfs_example](nfs_example), written in `Rust`, demonstrates the usage of NFS read and write operations.
1013
Demonstrates code to interface with Launcher, perform handshake to authenticate itself and then do a
1114
few NFS operations.
1215

‎demo_app/README.md‎

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,74 @@
11
# maidsafe_demo_app
2-
MaidSafe demo application
2+
MaidSafe demo application demonstrates the key features of the SAFE Network.
3+
4+
# Quick start
5+
The development dependency of this project is [Node.js](https://nodejs.org).
6+
Then type few commands known to every Node developer...
7+
```
8+
npm install
9+
npm start
10+
```
11+
12+
# Development
13+
14+
#### Installation
15+
16+
```
17+
npm install
18+
```
19+
It will also download Electron runtime, and install dependencies for second `package.json` & `bower.json` file inside `app` folder.
20+
21+
#### Starting the app
22+
23+
```
24+
npm start
25+
```
26+
27+
#### Adding npm modules to your app
28+
29+
Remember to add your dependency to `app/package.json` file, so do:
30+
```
31+
cd app
32+
npm install name_of_npm_module --save
33+
```
34+
35+
#### Unit tests
36+
37+
To run it go with standard:
38+
```
39+
npm test
40+
```
41+
42+
# Making a distributable package
43+
44+
To make ready for distribution package use command based on the platform:
45+
```
46+
npm run package
47+
```
48+
this will generate the package files in the `app_dist` folder
49+
50+
51+
# Making a release
52+
53+
To make ready for distribution installer use command:
54+
```
55+
npm run release
56+
```
57+
It will start the packaging process for operating system you are running this command on. Ready for distribution file will be outputted to `releases` directory.
58+
59+
You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems.
60+
61+
## Mac only
62+
63+
#### App signing
64+
65+
The Mac release supports [code signing](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/Procedures/Procedures.html). To sign the `.app` in the release image, include the certificate ID in the command as so,
66+
```
67+
npm run release -- --sign A123456789
68+
```
69+
70+
## Windows only
71+
72+
#### Installer
73+
74+
The installer is built using [NSIS](http://nsis.sourceforge.net). You have to install NSIS version 3.0, and add its folder to PATH in Environment Variables.

‎dns_example/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Safe DNS Example
22

3-
An example application to demonstrate uploading files of a static website to the Safe network.
4-
This examples showcases features from the `safe_nfs` and `safe_dns` crates and also the IPC connection with Launcher.
5-
The application can not be run as a Standalone example.
3+
An example application to demonstrate uploading files of a static website to the Safe network.
4+
This examples showcases features from the `safe_nfs` and `safe_dns` crates and also the IPC connection with Launcher.
5+
The application can not be run as a Standalone example.
66
Can work only with [safe_launcher](https://github.com/maidsafe/safe_launcher)
77

88
## Prerequisites
@@ -28,10 +28,10 @@ $ npm run build-osx
2828

2929
Builds the app for OS X, Linux, and Windows, using [electron-packager](https://github.com/maxogden/electron-packager).
3030

31-
### Logging
31+
### TODO
3232

33-
Application by default Log level is 'info'
34-
35-
Log level can be explicitly set by passing `--LOG_LEVEL` command line argument.
36-
37-
Permitted values for LOG_LEVEL can be found [here](https://www.npmjs.com/package/npmlog#log-level-prefix-message)
33+
[ ] Refactor UI components
34+
[ ] Improve error handling while directory uploading
35+
[ ] Improve progress indicator
36+
[ ] Add Rename functionality
37+
[ ] Cut, Copy, Paste features

0 commit comments

Comments
 (0)