Browse Source

Add license and readme

master
Dylan Baker 5 years ago
parent
commit
c59d3520d4
4 changed files with 40 additions and 2 deletions
  1. 1
    1
      Cargo.lock
  2. 1
    1
      Cargo.toml
  3. 19
    0
      LICENSE
  4. 19
    0
      README.md

+ 1
- 1
Cargo.lock View File

@@ -80,7 +80,7 @@ version = "1.0.4"
80 80
 source = "registry+https://github.com/rust-lang/crates.io-index"
81 81
 
82 82
 [[package]]
83
-name = "bnglws-client"
83
+name = "bngl"
84 84
 version = "0.1.0"
85 85
 dependencies = [
86 86
  "chrono 0.4.6 (registry+https://github.com/rust-lang/crates.io-index)",

+ 1
- 1
Cargo.toml View File

@@ -1,5 +1,5 @@
1 1
 [package]
2
-name = "bnglws-client"
2
+name = "bngl"
3 3
 version = "0.1.0"
4 4
 authors = ["Dylan Baker"]
5 5
 edition = "2018"

+ 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.

+ 19
- 0
README.md View File

@@ -0,0 +1,19 @@
1
+# bngl.ws client
2
+
3
+This is the CLI component of the bngl.ws pastebin service.
4
+
5
+## Installation
6
+
7
+With [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed
8
+
9
+```
10
+$ git clone https://git.sr.ht/~simulacrumparty/bnglws-client
11
+$ cd bnglws-client
12
+$ cargo install --path .
13
+```
14
+
15
+## Usage
16
+
17
+```
18
+$ echo 'Hello world' | bngl new 'My first snippet'
19
+```

Loading…
Cancel
Save