diff --git a/README.md b/README.md index d28b5d11..620876a2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -maybe_hero +maybe_hero # ~Maybe~Sure: The personal finance app for everyone -Get -involved: [Discord](https://link.maybe.co/discord) • [Website](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. ## Backstory @@ -33,27 +34,14 @@ Join us? ## Maybe Hosting -There are 2 primary ways to use the Maybe app: +Maybe is a fully working personal finance app that can be [self hosted with Docker](docs/hosting/docker.md). -1. Managed (easiest) - we're in alpha and release invites in our Discord -2. [Self-host with Docker](docs/hosting/docker.md) +## Forking and Attribution -## Contributing +This repo is no longer maintained. You’re free to fork it under the AGPLv3. To stay compliant and avoid trademark issues: -Before contributing, you'll likely find it helpful -to [understand context and general vision/direction](https://github.com/maybe-finance/maybe/wiki). - -Once you've done that, please visit -our [contributing guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md) -to get started! - -### Performance Issues - -With data-heavy apps, inevitably, there are performance issues. We've set up a public dashboard showing the problematic requests, along with the stacktraces to help debug them. - -Any contributions that help improve performance are very much welcome. - -https://oss.skylight.io/app/applications/XDpPIXEX52oi/recent/6h/endpoints +- 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) ## Local Development Setup @@ -87,14 +75,6 @@ credentials to log in (generated by DB seed): For further instructions, see guides below. -### Multi-currency support - -If you'd like multi-currency support, there are a few extra steps to follow. - -1. Sign up for an API key at [Synth](https://synthfinance.com). It's a Maybe - product and the free plan is sufficient for basic multi-currency support. -2. Add your API key to your `.env` file. - ### Setup Guides - [Mac dev setup guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide) @@ -102,10 +82,6 @@ If you'd like multi-currency support, there are a few extra steps to follow. - [Windows dev setup guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide) - Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more -## Repo Activity - -![Repo Activity](https://repobeats.axiom.co/api/embed/7866c9790deba0baf63ca1688b209130b306ea4e.svg "Repobeats analytics image") - ## Copyright & license Maybe is distributed under