license and contributing files and update readme

README.md

@@ -1,36 +1,51 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# SocialDB
 
-## Getting Started
+A self hosted (for now) personal CRM for managing your contacts.
 
-First, run the development server:
+NOTICE: This project is still in early alpha and is not yet ready for use.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## Description
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+I've had the idea for this project for over five years now, but I haven't
+gotten around to building it. I've always wanted somewhere to keep track of
+the people I meet and the conversations I have with them, especially those
+friends who live far away and I don't see often.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+There are other personal CRM tools already, including the self hostable
+Monica, but none of them quite fit my needs.
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+## Planned Features
 
-## Learn More
+- [ ] Creating and viewing people
+- [ ] Creating and viewing activities
+- [ ] Creating and viewing reports
+- [ ] Full markdown support for reports
+- [ ] @linking people and activities in reports
+- [ ] Creating and adding custom fields to people
+- [ ] Tags for all objects
+- [ ] Sorting and filtering all objects
+- [ ] Full text search
+- [ ] Vector search
+- [ ] Image uploading
+- [ ] Image embedding in reports
+- [ ] Import and export of people as contacts
+- [ ] Graph view of connections between people and reports
 
-To learn more about Next.js, take a look at the following resources:
+## Implementation
 
-- [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.
+I'm using Next.js and Tailwind for the frontend because I'm familiar with them
+and they're easy to use.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+For the database, I'm using PostgreSQL with the pgvector extension and Drizzle ORM. For small
+self hosted setups it should be PLENTY fast enough even with many thousands of people and reports.
 
-## Deploy on Vercel
+I'm not sure about auth yet, but probably NextAuth.
 
-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.
+## Deployment
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+The project is meant to be self hosted, with a single docker compose file to deploy the application and the database.
+It's still in the early stages of development, so it's not yet ready for production.
+
+## License
+
+This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.