Readme Updates

readme.md

@@ -0,0 +1,64 @@
+[![Banner](https://tweerup.herokuapp.com/tweet?username=iamyazreza)](https://github.com/ghulamyazdani/tweetup)
+
+<div align="center">
+<a href="https://github.com/ghulamyazdani/tweetup"><img alt="Opensource" title="Website" src="https://badges.frapsoft.com/os/v2/open-source.svg?v=103"/></a>
+<a href="https://github.com/ghulamyazdani/tweetup/blob/master/LICENSE"><img alt="Licence" title="Website" src="https://img.shields.io/github/license/ghulamyazdani/tweetup?logo=GITHUB&style=flat"/></a>
+<a href="https://discord.gg/zCEhm2JvEF"><img alt="Discord" title="Website" src="https://img.shields.io/discord/857641826953854987?color=blue&label=Discuss&logo=discord"/></a>
+
+</div>
+
+## 🌟 About
+
+An Api which generate a randome twitter tweets svg with your twitter handle just like shown in above image.
+
+## 🤔How to use?
+
+It just easy as adding an image to your github readme !
+
+Just copy below link to
+
+` https://tweerup.herokuapp.com/tweet?username=[your_twitter_handle]`
+Replace [your_twitter_handle] with your twitter original handle else it wont work.
+
+## 🧰 Setup
+
+- By forking, clone the repository in your local system.
+- Run `npm install` in Terminal it will Install all the dependencies which is required for this project.
+- Now you will have to add a file named `.env` in your project root directory.And add Port number,Hostnames and bearer token from twitter api in it.
+- Run `npm start` To run the nodejs server in local environment.
+
+## ⚡ Requirements
+
+- Your **node version** should be above v16.
+- Downlaod the latest version of **npm**.
+- Downloading **Eslint** and **prettier** will be plus.
+
+## 🧑‍🤝‍🧑 How to contribute
+
+Follow the steps given in contributing.md in order to contribute to this project.
+
+## 🏗 Project Structure
+
+```
+├───assets
+│   └───Poster
+├───node_modules
+├───src
+│   └───main.ts
+│   └───fethcer.ts
+│   └───tweet.ts
+│   └───tweetcard.ts
+├───package.json
+```
+
+## 👨‍💻 Project Admin
+
+  <div align="center">
+<table>
+<tr>
+
+<td align="center"><a href="https://github.com/ghulamyazdani"><img src="https://avatars.githubusercontent.com/u/55938346?v=4" width=150px height=150px /></a></br> <h4 style="color:white;">Ghulamyazdani</h4>
+
+</tr>
+</table>
+<br>