Skip to content

Commit

Permalink
fix typos, add logo
Browse files Browse the repository at this point in the history
  • Loading branch information
rushfive committed Mar 27, 2019
1 parent ca72291 commit d5d0cd4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
Binary file added Documentation/ffdb_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/ffdb_logo.psd
Binary file not shown.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# NFL Database Engine
![alt text](/Documentation/ffdb_logo.png)

###### Easily create your own NFL databases to power your football and fantasy apps!

---

__R5.FFDB.Engine__

Expand Down Expand Up @@ -166,7 +170,7 @@ Usage: `ffdb setup`

Options:

- `skip-stats` - will skip adding all missing stats after running the initial database setup. Usage: `ffdb initial-setup --skip-stats`
- `skip-stats` - will skip adding all missing stats after running the initial database setup. Usage: `ffdb setup --skip-stats`

###### Add Stats

Expand All @@ -177,9 +181,9 @@ Usage: `ffdb add-stats week 2018-1` or `ffdb add-stats missing`
Options:

- `save-to-disk` - save the versioned files to disk. This is what the Engine needs to create the database.
Usage: `ffdb initial-setup --skip-stats`
Usage: `ffdb add-stats missing --save-to-disk`
- `save-src-files` - save the original source response as a file. In most cases, this is the JSON or XML response from the request.
Usage: `ffdb initial-setup --save-src-files`
Usage: `ffdb add-stats missing --save-src-files`

###### Update Players

Expand Down Expand Up @@ -217,7 +221,7 @@ There are 2 options that can be used with any of the commands above.
The engine is what does all the real work behind the scenes - the CLI is just an interface to it. Given that, the Engine is also released separately as its own nuget package for those that would like to interact with it programmatically:

```
dotnet add package R5.FFDB.Core --version 1.0.0-alpha.1
dotnet add package R5.FFDB.Engine --version 1.0.0-alpha.1
```

##### Design Overview
Expand Down

0 comments on commit d5d0cd4

Please sign in to comment.