diff --git a/README.md b/README.md new file mode 100644 index 0000000..f5f9a81 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Java SQLite Viewer +A GUI application to view and edit SQLite databases. Based on an intermediate swing project, +I added some neat features such as file selection and named borders around the sections. + +![Screenshot of the text editor](./app/res/screenshot-viewer.png) + +## Install +- Download the .jar file (requires JVM) _or_ binary for your system +- Alternatively you can download the source code and compile it yourself + +## How to use +- Load a *.db file from disk from the menu +- Open it (connect) +- Select the table you want to edit or view +- See the result in the area below + +_To get started you can download a sample file from sqlitetutorial.net [here](https://www.sqlitetutorial.net/sqlite-sample-database/)._ + +## Technologies +- Java +- Gradle +- SQLite + +## Roadmap +I plan on adding support for more SQL-flavours such as PostgresQL, MySQL and MSSQL in the future. diff --git a/app/res/screenshot-viewer.png b/app/res/screenshot-viewer.png new file mode 100644 index 0000000..c69acd2 Binary files /dev/null and b/app/res/screenshot-viewer.png differ