Browse Source

Add license and readme

master
Dylan Baker 5 years ago
parent
commit
f7b05609f5
2 changed files with 35 additions and 0 deletions
  1. 19
    0
      LICENSE
  2. 16
    0
      README.md

+ 19
- 0
LICENSE View File

@@ -0,0 +1,19 @@
1
+Copyright 2019 Dylan Baker
2
+
3
+Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+this software and associated documentation files (the "Software"), to deal in
5
+the Software without restriction, including without limitation the rights to
6
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7
+of the Software, and to permit persons to whom the Software is furnished to do
8
+so, subject to the following conditions:
9
+
10
+The above copyright notice and this permission notice shall be included in all
11
+copies or substantial portions of the Software.
12
+
13
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+SOFTWARE.

+ 16
- 0
README.md View File

@@ -0,0 +1,16 @@
1
+# bngl.ws server
2
+
3
+This is the server component of the bngl.ws pastebin service.
4
+
5
+## Running the server
6
+
7
+With [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
8
+and [diesel](https://crates.io/crates/diesel_cli) installed:
9
+
10
+```
11
+$ git clone https://git.sr.ht/~simulacrumparty/bnglws-server
12
+$ cd bnglws-server
13
+$ echo 'DATABASE_URL=postgres://username@host/dbname' > .env;
14
+$ diesel database setup
15
+$ cargo run
16
+```

Loading…
Cancel
Save