readme changed

.env.example

@@ -0,0 +1,3 @@
+NEWS_API_API_KEY=KEY_HERE
+THE_GUARDIAN_API_KEY=KEY_HERE
+THE_NEW_YORK_TIMES_API_KEY=KEY_HERE

README.md

@@ -1,40 +1,40 @@
-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).
+News Agreggator
 
-## Getting Started
-
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## About
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+- [News Agreggator](https://news-aggregator-web-app.vercel.app/) is a project that aggregates news from various places in one place, made with love and nextJs
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
-
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+## Getting Started
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+First, you will need to get 3 api keys, they are from:
 
-## Learn More
+- [The New York Times API](https://developer.nytimes.com/)
+- [News Api](https://newsapi.org/)
+- [The Guardian API](https://open-platform.theguardian.com/)
 
-To learn more about Next.js, take a look at the following resources:
+Get these key and create a .env at the root of the project
+there is a .env.example at the root.
 
-- [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.
+to run the project you will need to have [Dockcer](https://www.docker.com/) installed 
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+execute to create the container:
+```bash
+docker build -t news-agreggator .
+```
+than execute this to run the container for the first time:
+```bash
+docker compose up --build
+```
+if you want to run the project for the second time run:
+```bash
+docker compose up
+```
 
-## Deploy on Vercel
+## Tests
 
-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.
+There are some unit test, if you want to run them, execute:
+```bash
+npm run test
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+#neverstoplearning