diff --git a/README.md b/README.md index bdc713b..53cd433 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,34 @@ -# PostHub-app - -I use: -- TypeScript; -- React; -- NextUI; -- Framer Motion; -- TailwindCSS; +
+ +
+ +# 🚀 Welcome to our platform, **PostHub** + +This is a new platform for publishing your amazing posts. Here, you'll find a variety of different topics and interests. You can create whatever you like, generate new posts, engage in discussions in the comments, or simply read the latest updates and react to them. A convenient filtering and posting system will help you browse only the content that interests you, while interactions with other participants will keep things exciting. + +## 🖼️ Screenshots + +
+ + + + + +
+ +## 🛠 Development + +When developing use: +- `yarn dev` + +A development server will automatically open the project in your browser. Normally here: `http://localhost:8080`. + + +To build the project use: +- `yarn build` + +A web ready folder will be created in `/dist/`. + +## 📝 License + +[MIT](https://choosealicense.com/licenses/mit/)