diff --git a/README.md b/README.md index 7cbc9e6..1027438 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -partdb is an electronic parts manager. +partdb is an electronic parts inventory manager. + +usage +===== + +Once the service is installed, there is a single page to search, add, delete, or update parts. +The only aspect not handled by the web frontend is the attachments. +Just add the files directly on the server under `public/attachments//`. goals ===== @@ -59,3 +66,5 @@ mysql --user=partdb --password=password --database=partdb < schema.sql put the database access information in `credentials.json` and run `server.rb`. now go to http://localhost:4244 and you are ready to use it. + +use a proxy web server to handle the authentication, TLS, compression, ...