Merge pull request #1 from scorcism/main

update: readme.me && add: CONTRIBUTING.md && add LINCENSE

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# let's contribute
+
+
+### Contribute to this repository
+
+
+1. Fork the repository (Click the green Fork button in the top right of this page,
+
+click your Profile Image)
+
+2. Clone the **green** forked repository to your local machine.
+
+```bash
+https://github.com/<yourname>/oneliner.git
+
+```
+3. change the present working directory
+```bash
+
+cd oneliner
+
+```
+
+4. Open CMD in your current directory and run
+```markdown
+npm i 
+
+```
+
+> Run locally
+```
+npm run start
+
+```
+5. Add new one liner :
+
+> Go to **src > assets > `DB.json`** & add your code
+```json
+{
+	"question": "< Title >",
+	"answer": "< Desc about the title >",
+	"category": "< linux || python || Java || webdev || ethical>"
+},
+```
+- answer should not exceed **10-12 words**
+
+6. Make changes in the project. Add, Commit and push the project using following commands:
+
+
+> Add all files
+```bash
+git add .
+```
+> Commit the changes
+```bash
+
+git commit -m "Write Your commit Message"
+
+```
+
+> Create a new branch
+```bash
+
+git branch -M <your-name>
+
+```
+> Set upstream command to create a PR
+
+```diff
+git remote add upstream https://github.com/asPerReqirements/oneliner.git
+```
+> Push the branch
+
+
+
+```markdown
+
+git push
+
+```
+
+7. Create a new pull request from your forked repository (Click the `New Pull Request` button located at the top of your repo)
+
+### How to Create a PR
+
+1. After you push the changes you need to create a pull request and name the issue and mention the issue number,
+
+	eg: added oneliner #issuenumber
+
+2. Wait for your PR review and merge approval!
+
+3.  **Star the repo.**

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Abhishek Pathak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,27 @@
-# One Liner
+# one-liner
+
+Many times, we just want to know about the meaning or the use of the keyword in one line. So, Oneliner is the tool that will help you with that.
+
+**Live Project**: https://oneliner.vercel.app/
+![](https://i.imgur.com/1ybB9Yr.png)
+
+## Tech Stack
+- [React JS](https://react.dev/) -> React is a free and open-source front-end JavaScript library for building user interfaces based on components.
+- [Vercel](https://vercel.com/) -> For deployment.
+
+## Contributions
+> **Note**: If you are new to open source contributions, you can refer to [this](https://opensource.guide/how-to-contribute/) guide by GitHub.
+- Go through the [CONTRIBUTING.md](/CONTRIBUTING.md) file, where all the guidelines have been mentioned that will guide you to make your contribution.
+- Do check out the [project issue tracker](https://github.com/asPerReqirements/oneliner/issues) section.
+- Follow conventional commits for commit messages. You can read more about it [here](https://www.conventionalcommits.org/en/v1.0.0/).
+- Make sure to add the issue number in the commit message. For example, `git commit -m "fix: fixed a bug in the navbar #1"`.
+- Make sure to add the issue number in the PR title & description. For example, `fix: fixed a bug in the navbar #1`.
+- If your PR is an invalid one, it will be marked as `invalid` and closed. 
+- If your PR is a duplicate one, it will be marked as `duplicate` and closed.
+
+## License
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Contributors
+
+ <img src="https://contrib.rocks/image?repo=asPerReqirements/oneliner" />