Skip to content

Commit c7a03f2

Browse files
committed
Update README
1 parent 1d80293 commit c7a03f2

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# Bitstream Go
22

3-
Implementation of [bitstream protocol](https://robinlinus.com/bitstream.pdf) in Go.
3+
Implementation of [bitstream protocol](https://robinlinus.com/bitstream.pdf) in Go.
4+
5+
# Example usage
6+
7+
You can find an example of how to use this library in the [example](example) directory.

example/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
## TODO: Add usage examples
1+
# Example usage
2+
3+
### Encrypting the file
4+
```
5+
go run example/main.go -action=encrypt -in=bitcoin.pdf -out=bitcoin-enc.pdf -hash=00000000000000000000000000000000000000 -preimage=0000000000000000000000000000000000000000
6+
```
7+
8+
#### Decrypting the file
9+
```
10+
go run example/main.go -action=decrypt -in=bitcoin-enc.pdf -out=bitcoin-dec.pdf -hash=00000000000000000000000000000000000000 -preimage=0000000000000000000000000000000000000000
11+
```

0 commit comments

Comments
 (0)