diff --git a/README.md b/README.md index 3ca31bf2e..5a33be797 100644 --- a/README.md +++ b/README.md @@ -19,31 +19,22 @@ involved: [Discord](https://discord.gg/36ZGBsxYEK) • [(archived) Website](https://web.archive.org/web/20250715182050/https://maybefinance.com/) • [Issues](https://github.com/we-promise/sure/issues) > [!IMPORTANT] -> This repository is a community fork of the official (now abandoned) Maybe Finance one. -> You can read more about this in their [final release](https://github.com/maybe-finance/maybe/releases/tag/v0.6.0) doc. +> This repository is a community fork of the now-abandoned Maybe Finance project. +> Learn more in their [final release](https://github.com/maybe-finance/maybe/releases/tag/v0.6.0) doc. ## Backstory -The Maybe Finance team spent the better part of 2021/2022 building a personal -finance + wealth management app called "Maybe". Very full-featured, including -an "Ask an Advisor" feature which connected users with an actual CFP/CFA to -help them with their finances (all included in your subscription). +The Maybe Finance team spent most of 2021–2022 building a full-featured personal finance and wealth management app. It even included an “Ask an Advisor” feature that connected users with a real CFP/CFA — all included with your subscription. -The business end of things didn't work out, and so they shut things down mid-2023. +The business end of things didn't work out, and so they stopped developing the app in mid-2023. -Having spent the better part of $1,000,000 building the app (employees + -contractors, data providers/services, infrastructure, etc.) they decided to -revive the product as a fully open-source project. The goal was to -let you run the app yourself, for free, and use it to manage your own finances -and eventually offer a hosted version of the app for a small monthly fee. +After spending nearly $1 million on development (employees, contractors, data providers, infra, etc.), the team open-sourced the app. Their goal was to let users self-host it for free — and eventually launch a hosted version for a small fee. -Which they did. Offer a hosted version for a short while. +They actually did launch that hosted version… briefly. -That didn't work either (well, the "making it a sustainable B2C business" part -didn't) so here we are hosting a community maintained fork hoping to keep the -codebase alive and who knows what else will come next. +That also didn’t work out — at least not as a sustainable B2C business — so now here we are: hosting a community-maintained fork to keep the codebase alive and see where this can go next. -Join us? +Wanna join us? ## Hosting ~Maybe~Sure @@ -51,27 +42,26 @@ Sure is a fully working personal finance app that can be [self hosted with Docke ## Forking and Attribution -This repo is a community fork of the no longer maintained Maybe Finance one. -You’re free to fork it under the AGPLv3 but we prefer if you stay here and contribute. +This repo is a community fork of the archived Maybe Finance repo. +You’re free to fork it under the AGPLv3 license — but we’d love it if you stuck around and contributed here instead. + To stay compliant and avoid trademark issues: - Be sure to include the original [AGPLv3 license](https://github.com/maybe-finance/maybe/blob/main/LICENSE) and clearly state in your README that your fork is based on Maybe Finance but is **not affiliated with or endorsed by** Maybe Finance Inc. -- "Maybe" is a trademark of Maybe Finance Inc. and therefore, use of it is NOT allowed in forked repositories (or the logo) +- Don’t use the word “Maybe” in your project name or logo — it’s a trademark of Maybe Finance Inc. ## Local Development Setup -**If you are trying to _self-host_ the Maybe app, stop here. You -should [read this guide to get started](docs/hosting/docker.md).** +**If you are trying to _self-host_ the app, [read this guide to get started](docs/hosting/docker.md).** The instructions below are for developers to get started with contributing to the app. ### Requirements - See `.ruby-version` file for required Ruby version -- PostgreSQL >9.3 (ideally, latest stable version) - -After cloning the repo, the basic setup commands are: +- PostgreSQL >9.3 (latest stable version recommended) +### Getting Started ```sh cd sure cp .env.local.example .env.local @@ -82,8 +72,7 @@ bin/dev rake demo_data:default ``` -And visit http://localhost:3000 to see the app. You can use the following -credentials to log in (generated by DB seed): +Visit http://localhost:3000 to view the app. You can log in with these demo credentials (from the DB seed): - Email: `user@maybe.local` - Password: `password` @@ -92,14 +81,14 @@ For further instructions, see guides below. ### Setup Guides -- [Mac dev setup guide](https://github.com/we-promise/sure/wiki/Mac-Dev-Setup-Guide) -- [Linux dev setup guide](https://github.com/we-promise/sure/wiki/Linux-Dev-Setup-Guide) -- [Windows dev setup guide](https://github.com/we-promise/sure/wiki/Windows-Dev-Setup-Guide) -- Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more +- [Mac dev setup](https://github.com/we-promise/sure/wiki/Mac-Dev-Setup-Guide) +- [Linux dev setup](https://github.com/we-promise/sure/wiki/Linux-Dev-Setup-Guide) +- [Windows dev setup](https://github.com/we-promise/sure/wiki/Windows-Dev-Setup-Guide) +- Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers) -## Copyright & license +## License and Trademarks -Maybe/Sure are distributed under +Maybe and Sure are both distributed under an [AGPLv3 license](https://github.com/we-promise/sure/blob/main/LICENSE). -Remember that "Maybe" is a trademark of Maybe Finance, Inc. -"Sure" is not. +- "Maybe" is a trademark of Maybe Finance, Inc. +- "Sure" is not, and refers to this community fork.