diff --git a/README.md b/README.md index 397b08b..e0e1dbd 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,27 @@ -# README +# Dequoter -## About +A simple Boop clone for Mac OS. Useful as a scratchpad for performing text manipulation. -This is the official Wails Vanilla template. - -You can configure the project by editing `wails.json`. More information about the project settings can be found -here: https://wails.io/docs/reference/project-config - -## Live Development - -To run in live development mode, run `wails dev` in the project directory. This will run a Vite development -server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser -and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect -to this in your browser, and you can call your Go code from devtools. +**Currently In Alpha:** There are some glaring issues, such as text not being saved between invocations. +This means that **if you restart the app, you will loose your work.** Treat this like an untitled TextEdit window, +where all your chances will be lost when you close it. ## Building -To build a redistributable, production mode package, use `wails build`. +This project uses [Wails](https://wails.io) to build a desktop application with a Go backend and a Vite frontend. + +## License + +Copyright 2026 Leon Mika + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated +documentation files (the “Software”), to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and +to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file