Skip to content
Snippets Groups Projects
Commit cf7c308a authored by Jake Taylor's avatar Jake Taylor
Browse files

cleanup README

parent 27bb5ddb
Branches
Tags
1 merge request!510Release
# Initialization # Server Initialization
These steps must first be performed in order to begin creating server objects of any variety. These steps must first be performed in order to begin creating server objects of any variety.
...@@ -9,7 +9,7 @@ The api.Client object created here will be used for all types of api.Identity an ...@@ -9,7 +9,7 @@ The api.Client object created here will be used for all types of api.Identity an
1. Obtain the NDF 1. Obtain the NDF
```go ```go
ndfJson, err := DownloadAndVerifySignedNdfWithUrl(url, cert) ndfJson, err := api.DownloadAndVerifySignedNdfWithUrl(url, cert)
``` ```
2. If not done in previous runs, create a new api.Client object in storage using ndfJson. 2. If not done in previous runs, create a new api.Client object in storage using ndfJson.
...@@ -18,7 +18,7 @@ ndfJson, err := DownloadAndVerifySignedNdfWithUrl(url, cert) ...@@ -18,7 +18,7 @@ ndfJson, err := DownloadAndVerifySignedNdfWithUrl(url, cert)
Example: Example:
```go ```go
err := NewClient(ndfJson, "/clientStorage", []byte("testPassword"), "") err := api.NewClient(ndfJson, "/clientStorage", []byte("testPassword"), "")
``` ```
3. Login in order to obtain the api.Client object. 3. Login in order to obtain the api.Client object.
...@@ -28,7 +28,7 @@ err := NewClient(ndfJson, "/clientStorage", []byte("testPassword"), "") ...@@ -28,7 +28,7 @@ err := NewClient(ndfJson, "/clientStorage", []byte("testPassword"), "")
Example: Example:
```go ```go
client, err := Login("/clientStorage", []byte("testPassword"), api.GetDefaultParams()) client, err := api.Login("/clientStorage", []byte("testPassword"), api.GetDefaultParams())
``` ```
4. Start the network follower. Timeout may be modified as needed. 4. Start the network follower. Timeout may be modified as needed.
...@@ -47,10 +47,10 @@ It requires an api.Client object. ...@@ -47,10 +47,10 @@ It requires an api.Client object.
Example: Example:
```go ```go
identity, err := MakeIdentity(client.GetRng(), client.GetStorage().GetE2EGroup()) identity, err := api.MakeIdentity(client.GetRng(), client.GetStorage().GetE2EGroup())
``` ```
# Creating Servers # Building Servers
### Creating Connect-backed Servers ### Creating Connect-backed Servers
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment