Add a usage section to README

Changes

1 changed files (+8/-0)

• README.md
  • @@ -2,6 +2,14 @@ # SD
    Very efficient flash cards app using Go and SQLite + ## Usage + + Flash cards are stored in the `cards` table of a SQLite database. There are four columns: `idx INTEGER PRIMARY KEY, weight INTEGER, key STRING, val STRING`. The `idx` is a unique index for each card, starting at 0. The weight is how often the card should come up. The key and value are the front and reverse sides of the card. You can use the `sqlite3` CLI to create a card deck. + + Now build this project with `go build` and run `./sd` to enjoy a fast flash cards experience! + + If you're wondering where the name came from, I named this app after a common type of flash card. 😀 + ## Performance SD is designed to be extremely efficient in order to support a very large number of flash cards and should be able to handle several billion cards with ease. If `N` is the number of cards, initializing the program requires `O(N)` time and `O(N)` memory. Selecting a random card and adjusting its weight based on if the user got it correct requires `O(log N)` time.