Skip to content

Commit 7d3bc27

Browse files
committed
Wrap paragraphs in readme at 80 characters
1 parent 6b24981 commit 7d3bc27

File tree

1 file changed

+34
-25
lines changed

1 file changed

+34
-25
lines changed

README.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
11
# Padlock Cloud
22

3-
Padlock Cloud is a cloud storage and synchronization service for the
4-
[Padlock app](https://github.com/maklesoft/padlock/) implemented in Go. It provides a (mostly) RESTful api
5-
for storing and retrieving user data. Padlock Cloud does NOT implement any kind of
6-
diffing algorithm, nor does it attempt to provide any kind of cryptographic functionality. Any encryption,
7-
decryption and data consolidation should happen on the client side. Padlock Cloud merely provides a
8-
cloud-based storage for encrypted user data.
3+
Padlock Cloud is a cloud storage service for the
4+
[Padlock app](https://github.com/maklesoft/padlock/) implemented in Go. It
5+
provides a (mostly) RESTful api for storing and retrieving user data. Padlock
6+
Cloud does NOT implement any kind of diffing algorithm, nor does it attempt to
7+
provide any kind of cryptographic functionality. Any encryption, decryption and
8+
data consolidation should happen on the client side. Padlock Cloud merely
9+
provides a cloud-based storage for encrypted user data.
910

1011
## How to install/build
1112

12-
First, you'll need to have [Go](https://golang.org/) installed on your system. Then simply run
13+
First, you'll need to have [Go](https://golang.org/) installed on your system.
14+
Then simply run
1315

1416
```sh
1517
go get github.com/maklesoft/padlock-cloud
1618
```
1719

18-
This will download the source code into your `$GOPATH` and automatically build and install the
19-
`padlock-cloud` binary into `$GOPATH/bin`. Assuming you have `$GOPATH/bin` added
20-
to your path, you should be the be able to simply run the `padlock-cloud` command from anywhere.
20+
This will download the source code into your `$GOPATH` and automatically build
21+
and install the `padlock-cloud` binary into `$GOPATH/bin`. Assuming you have
22+
`$GOPATH/bin` added to your path, you should be the be able to simply run the
23+
`padlock-cloud` command from anywhere.
2124

2225
## Usage
2326

24-
The `padlock-cloud` command provides commands for starting Padlock Cloud server and managing
25-
accounts. It can be configured through various flags and environment variables.
27+
The `padlock-cloud` command provides commands for starting Padlock Cloud server
28+
and managing accounts. It can be configured through various flags and
29+
environment variables.
2630

27-
Note that **global flags** have to be specified **before** the command and **command-specific** flags
28-
**after** the command but before any positional arguments.
31+
Note that **global flags** have to be specified **before** the command and
32+
**command-specific** flags **after** the command but before any positional
33+
arguments.
2934

3035
```sh
3136
padlock-cloud [global options] command [command options] [arguments...]
@@ -37,16 +42,18 @@ For a list of available commands and global options, run.
3742
padlock-cloud --help
3843
```
3944

40-
For information about a specific command, including command-specific options, run
45+
For information about a specific command, including command-specific options,
46+
run
4147

4248
```sh
4349
padlock-cloud command --help
4450
```
4551

4652
### Config file
4753

48-
The `--config` flag offers the option of using a configuration file instead of command line flags. The
49-
provided file should be in the [YAML format](http://yaml.org/). Here is an example configuration file:
54+
The `--config` flag offers the option of using a configuration file instead of
55+
command line flags. The provided file should be in the
56+
[YAML format](http://yaml.org/). Here is an example configuration file:
5057

5158
```yaml
5259
---
@@ -69,7 +76,8 @@ log:
6976
notify_errors: [email protected]
7077
```
7178
72-
**NOTE**: If you are using a config file, all other flags and environment variables will be ingored.
79+
**NOTE**: If you are using a config file, all other flags and environment
80+
variables will be ingored.
7381
7482
## Security Considerations
7583
@@ -119,12 +127,13 @@ recommended to use this option in production environments at all times!
119127
### Failed to load templates
120128

121129
```sh
122-
2016/09/01 21:40:59 open asdf/templates/activate-auth-token-email.txt: no such file or directory
130+
2016/09/01 21:40:59 open some/path/activate-auth-token-email.txt: no such file or directory
123131
```
124132

125-
The Padlock Cloud server requires various assets like templates for rendering emails, web
126-
pages etc. These are included in this repository under the `assets` folder. When you're running
127-
`padlock-cloud` you'll have to make sure that it knows where to find these assets. You can do that
128-
via the `--assets-path` option. By default, the server will look for the templates under
129-
`$GOPATH/src/github.com/maklesoft/padlock-cloud/assets/templates` which is where they will usually be
130-
if you installed `padlock-cloud` via `go get`.
133+
The Padlock Cloud server requires various assets like templates for rendering
134+
emails, web pages etc. These are included in this repository under the `assets`
135+
folder. When you're running `padlock-cloud` you'll have to make sure that it
136+
knows where to find these assets. You can do this via the `--assets-path`
137+
option. By default, the server will look for the templates under
138+
`$GOPATH/src/github.com/maklesoft/padlock-cloud/assets/templates` which is
139+
where they will usually be if you installed `padlock-cloud` via `go get`.

0 commit comments

Comments
 (0)