added To add to the bottom of the readme

This commit is contained in:
booboy 2018-11-09 22:58:47 -06:00
parent c4fde291e4
commit eaf5e306c0

View file

@ -2,7 +2,7 @@
Check out the examples folder for some examples. I will add more soon.
## Usage
Set these three environment variables:
Set the following environment variables:
```
pastebin_api_key
@ -11,8 +11,8 @@ pastebin_password
```
If you want to scrape pastes, you can view a json response of the latest pastes by using the ```-s``` or ```--scrape_public``` options.
Creating pastes is built in, check ```lib/pastebinner.rb```, I am still working on adding in the functionality to use it on the command line.
The command line app can be used as follows:
Creating pastes is built in, check ```lib/pastebinner.rb```, I am still working on adding in the functionality to use it on the command line.
The command line app can be used as follows:
```shell
pastebinner --help
@ -27,7 +27,7 @@ Usage: pastebinner [options]
```
### Downloading pastes
Create a directory in the git repo named data, this is where the raw pastes will be stored.
Here is an example of what it looks like:
Here is an example of what it looks like:
```shell
pastebinner --download
@ -38,6 +38,12 @@ Complete.
The data directory will then be populated with pastebin raw paste files with the following naming scheme:
```shell
pastebin_paste_key_agiArDuG pastebin_paste_key_f9sZ4zfZ pastebin_paste_key_kkS48wHT pastebin_paste_key_rjxNDUbN pastebin_paste_key_vu5HSagJ pastebin_paste_key_ZZrUy4Fa
pastebin_paste_key_AHMT1YSC pastebin_paste_key_f9Zn6FWf pastebin_paste_key_kLVdVpTW pastebin_paste_key_rLDbHTZN pastebin_paste_key_vv6R1Dz4
pastebin_paste_key_agiArDuG
```
### To Add:
- fulltext search of raw pastes via elastic search, mysql, postgres, sqlite, or some other method
- create pastes from the command line
- adding exceptions
- adding configuration file support
- adding rspec tests