[Docs]: Improve README.md + Add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributor's Guideline
+
+Thank you for your interest in contributing to ShipTalkers! We welcome contributions from the community to help make this project better. Whether it's a bug report, a new feature request, or a code improvement, your contributions are valuable and appreciated.
+
+## Ways to Contribute
+
+### Reporting Bugs
+
+If you encounter a bug or issue while using ShipTalkers, please report it by opening a new issue on our [GitHub repository](https://github.com/yourusername/shiptalkers/issues/new). When creating a new issue, please provide as much detail as possible, including:
+
+- A clear and descriptive title
+- A detailed description of the issue
+- Steps to reproduce the issue
+- Any relevant error messages or screenshots
+
+### Suggesting Features
+
+If you have an idea for a new feature or an improvement to an existing one, we'd love to hear it! Open a new issue on our [GitHub repository](https://github.com/yourusername/shiptalkers/issues/new) and describe your feature request in detail.
+
+### Submitting Code Changes
+
+If you'd like to contribute code changes to ShipTalkers, follow these steps:
+
+1. Fork the repository on GitHub.
+2. Create a new branch for your changes: `git checkout -b my-new-feature`
+3. Make your changes and commit them with descriptive commit messages.
+4. Push your changes to your forked repository: `git push origin my-new-feature`
+5. Create a new pull request on the main ShipTalkers repository, describing your changes in detail.
+
+Please make sure to follow our coding conventions and guidelines, which can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Code of Conduct
+
+We have adopted a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please read and follow the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
+
+## License
+
+By contributing to ShipTalkers, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).
+
+Thank you for your contribution and support! We appreciate your help in making ShipTalkers better.

README.md

@@ -1,21 +1,65 @@
-# TODO:
-
-- after comparing, give them a special name i.e "Indie Hacker, Reply Guy, etc"
-
-  - Special name ideas:
-  - `` - 5:0 commits to tweets
-  - `Grinder` - 3:1 commits to tweets
-  - `` - 2:1 commits to tweets
-  - `Perfectly Balanced` - 1:1 commits to tweets
-  - `Shiposter` - 1:2 commits to tweets
-  - `Indie Hacker` - 1:3 commits to tweets
-  - `Reply Guy` - 1:4 commits to tweets
-  - `Influencer` - 1:5 commits to tweets
-
-- while streaming the heatmap calendar, pop in their most commits in a day or biggest tweet
-- after comparing, show people with similar ratios
-- have a leaderboard, sorted from most to least commit ratios
-- for holidays, callout tweeting, coding, or living
+# [ShipTalkers](https://shiptalkers.dev/)
+ShipTalkers is an open-source project by [Rhys Sullivan](https://github.com/RhysSullivan) who aims to bring transparency to the tech community on Twitter. It compares the number of tweets a user has sent with their actual code contributions (commits) to determine if they are truly "shipping code" or just "shiptalk."
+
+## Features
+- **User Comparison**: Compare the ratio of tweets to commits for any Twitter user to see if they are backing up their tweets with actual code contributions.
+- **Special Titles**: Based on the tweet-to-commit ratio, users are assigned special titles ranging from "Grinder" (high commit ratio) to "Influencer" (low commit ratio).
+- **Heatmap Calendar**: While streaming a user's heatmap calendar, their most commits in a day or biggest tweet will be displayed.
+- **Similar Ratios**: See other users with similar tweet-to-commit ratios.
+- **Leaderboard**: A leaderboard sorted from the highest to lowest commit ratios.
+- **Holiday Callouts**: Special callouts for tweeting, coding, or living during holidays.
+
+## Upcoming Features
+- While comparing users, show people with similar ratios.
+- Have a leaderboard sorted from the highest to lowest commit ratios.
+- For holidays, callout tweeting, coding, or living.
+
+## TODO:
+- [ ] After comparing, give them a special name i.e. "Indie Hacker," "Reply Guy," etc.
+ - Special name ideas:
+ - [ ] Special name for 5:0 commits to tweets
+ - [x] `Grinder` - 3:1 commits to tweets
+ - [ ] Special name for 2:1 commits to tweets
+ - [x] `Perfectly Balanced` - 1:1 commits to tweets
+ - [x] `Shiposter` - 1:2 commits to tweets
+ - [x] `Indie Hacker` - 1:3 commits to tweets
+ - [x] `Reply Guy` - 1:4 commits to tweets
+ - [x] `Influencer` - 1:5 commits to tweets
+- [ ] While streaming the heatmap calendar, pop in their most commits in a day or biggest tweet
+- [ ] After comparing, show people with similar ratios
+- [ ] Have a leaderboard, sorted from most to least commit ratios
+- [ ] For holidays, callout tweeting, coding, or living
+
+## Getting Started (Development Setup)
+- Clone the repository by clicking on the code button and choose any option from the dropdown.
+
+    - Option 1: Copy this url and paste it in your terminal https://github.com/RhysSullivan/shiptalkers.git
+
+    - Option 2: Click the Open with Github Desktop Option which will open up the GUI client if it's installed on your machine
+
+    - Option 3: Download the project as zip and unzip it upon completing the download
+
+- Copy and paste this command in your terminal; to install the necessary modules
+
+    ```
+        pnpm install
+    ```
+
+- Run this commad to serve the project on your localhost 
+
+    ```
+        pnpm dev
+    ```
+
+- You will see the live app served at ``localhost:3000``
+
+## Contributing
+We welcome contributions from the community! If you have any ideas, bug reports, or feature requests, please open an issue or submit a pull request. Before creating a pull request make sure you read through the current open PRs so as not to create a duplicate of an already existent one.
+
+If it's your first time contributing to Open Source; [Github's Guide to Open Source](https://opensource.guide/) a good place to start. If you are a seasoned contributor; it will do you good to read our [Contributors Guideline](https://github.com/RhysSullivan/shiptalkers/blob/main/CONTRIBUTING.md)
+
+## Credits
+- [hieuSSR's tweet](https://twitter.com/hieuSSR/status/1751678016428888565) for inspiration.
 
 ## Credits
 

tailwind.config.ts

@@ -219,7 +219,6 @@ const config: Config = {
   plugins: [
     require("tailwindcss-animate"),
     require("@headlessui/tailwindcss"),
-    require("@tailwindcss/line-clamp"),
     require("@tailwindcss/forms"),
   ],
 } satisfies Config;