Initial README and LICENSE

LICENSE.md

@@ -0,0 +1,10 @@
+# O'Saasy License Agreement
+
+Copyright © 2025, 37signals LLC.
+
+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:
+
+1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+2. No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
+
+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.

README.md

@@ -1,22 +1,29 @@
 # Fizzy
 
-## Setting up for development
+This is the source code of [Fizzy](https://fizzy.do/), the Kanban tracking tool for issues and ideas by [37signals](https://37signals.com).
+
+## Development
+
+### Setting up
 
 First, get everything installed and configured with:
 
+```sh
 bin/setup
+bin/setup --reset # Reset the database and seed it
+```
 
 And then run the development server:
 
+```sh
 bin/dev
+```
 
-You'll be able to access the app in development at http://fizzy.localhost:3006
+You'll be able to access the app in development at http://fizzy.localhost:3006.
 
-You can reset the database and seed it with:
+To login, enter `david@37signals.com` and grab the verification code from the browser console to sign in.
 
-    bin/setup --reset
-
-## Running tests
+### Running tests
 
 For fast feedback loops, unit tests can be run with:
 
@@ -26,7 +33,15 @@ The full continuous integration tests can be run with:
 
     bin/ci
 
-## Outbound Emails
+### Database configuration
+
+Fizzy supports SQLite (default, recommended for most scenarios) and MySQL. You can switch adapters with the `DATABASE_ADAPTER` environment variable.
+
+```sh
+DATABASE_ADAPTER=mysql bin/rails
+```
+
+### Outbound Emails
 
 You can view email previews at http://fizzy.localhost:3006/rails/mailers.
 
@@ -36,3 +51,14 @@ You can enable or disable [`letter_opener`](https://github.com/ryanb/letter_open
 
 Under the hood, this will create or remove `tmp/email-dev.txt`.
 
+## Deployment
+
+We recommend [Kamal](https://kamal-deploy.org/) for deploying Fizzy. This project comes with a vanilla Rails template, you can find our production setup in [`fizzy-saas`](https://github.com/basecamp/fizzy-saas).
+
+## SaaS gem companion
+
+37signals bundles Fizzy with [`fizzy-saas`](https://github.com/basecamp/fizzy-saas), a companion gem that links Fizzy with our billing system and provides our production database and deployment setup.
+
+## License
+
+Fizzy is released under the [O'Saasy License](LICENSE.md).