README

README.md

@@ -1,36 +1,31 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# [Spliit](https://spliit.app)
 
-## Getting Started
+Spliit is a free and open source alternative to Splitwise. I created it back in 2022 as a side project to learn the Go language, but rewrote it with Next.js since.
 
-First, run the development server:
+## Features
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+- [x] Create a group and share it with friends
+- [x] Create expenses with description
+- [x] Display group balances
+- [x] Create reimbursement expenses
+- [x] Progressive Web App
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Work in progress
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+- [ ] Select all/no participant for expenses
+- [ ] Tell the application who you are when opening a group
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+## Stack
 
-## Learn More
+- [Next.js](https://nextjs.org/) for the web application
+- [TailwindCSS](https://tailwindcss.com/) for the styling
+- [shadcn/UI](https://ui.shadcn.com/) for the UI components
+- [Vercel](https://vercel.com/) for hosting (application and database)
 
-To learn more about Next.js, take a look at the following resources:
+## Contribute
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+The project is open to contributions. Feel free to open an issue or even a pull-request!
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## License
 
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+MIT, see [LICENSE](./LICENSE).