readme and license

README.md

@@ -1,34 +1,22 @@
-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).
+# [Echecs France](https://www.echecsfrance.com/)
 
-## Getting Started
+## A website displaying upcoming chess tournaments for the [FFE](http://www.echecs.asso.fr/) on a map
 
-First, run the development server:
+## Tech Stack
+This website is built in Typescript using:
+- [Next.js](https://nextjs.org/)
+- [Tailwind](https://tailwindcss.com/)
+- [MongoDB](https://www.mongodb.com/)
+- [Cypress](https://www.cypress.io/) 
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
+and is deployed on [Vercel](https://vercel.com/)
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Dependencies
+- [Leaflet](https://leafletjs.com/) - a Javascript library for interactive maps
+- [Nodemailer](https://nodemailer.com/about/) - a module for Node.js applications to allow easy as cake email sending
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Contributions
+Contributions are encouraged.
+Please open an issue to discuss your ideas. 
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [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.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## 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.
+Please see the TODO file for a list of suggestions.