From cc5bfb15d2f8c1de5ce21954ef69e72c072b51fd Mon Sep 17 00:00:00 2001 From: James Miller Date: Fri, 2 Aug 2019 17:56:21 -0500 Subject: [PATCH] update README.md --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b90d3c..1f8559c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # Pathfinder 2 Sqlite -This will be a repository for the code necessary to generate a sqlite database containing the open gaming content for the Pathfinder 2 table-top role-playing-game system that is available under the Open Gaming License. Pull requests welcomed! \ No newline at end of file +This will be a repository for the code necessary to generate a sqlite database +containing the open gaming content for the Pathfinder 2 table-top +role-playing-game system that is available under the Open Gaming License. Pull +requests welcomed! + +## Why sqlite? + +It's an open, permissively licensed, and portable single-file database that does +not require setting up a client/server model. It's also likely that the database +will fit into memory easily so performance issues aren't likely to be a problem. +Also, most use cases of this data will likely be read only, so the sqlite +limitations on concurrent writes won't be an issue either. + +## Why not JSON? + +Because I'd rather leverage sql's power, than writing internal code to a future +Pathfinder 2 app. Also, because sqlite is pretty much language agnostic at this +point; Pythonistas, Gophers, Rustaceans, and anything in between can access a +sqlite database. + +## Roadmap + +1. Design schema; +2. Write script to generated sqlite database from sql code; +3. Write sql code; and +4. Drinks for all when finished!