Update README.md

excalith · Dec 7, 2022 · c1bc840 · c1bc840
1 parent dd00795
commit c1bc840
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 53 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -7,48 +7,37 @@ The following is a set of guidelines for contributing to this repository.
 [Code of Conduct](#code-of-conduct)
 
 [How Can I Contribute?](#how-can-i-contribute)
-  * [Reporting Bugs](#reporting-bugs)
-  * [Suggesting Enhancements](#suggesting-enhancements)
-  * [Pull Requests](#pull-requests)
-  * [Commit Messages](#commit-messages)
+- [Contributing To Interactive Git Cheatsheet](#contributing-to-interactive-git-cheatsheet)
+      - [Table Of Contents](#table-of-contents)
+  - [Code of Conduct](#code-of-conduct)
+  - [How Can I Contribute?](#how-can-i-contribute)
+    - [Reporting Bugs](#reporting-bugs)
+    - [Suggesting Enhancements](#suggesting-enhancements)
+    - [Pull Requests](#pull-requests)
+    - [Commit Messages](#commit-messages)
 
 ## Code of Conduct
 This project and everyone participating in it is governed by the [Interactive Git Cheatsheet Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
 
 ## How Can I Contribute?
 ### Reporting Bugs
-Before creating bug reports, please perform a [cursory search](https://github.com/excalith/Interactive-Git-Cheatsheet/issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please include as many details as possible. Fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
+Before creating bug reports, please perform a [cursory search](https://github.com/excalith/git-cheats/issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please include as many details as possible. Fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
 
 > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
 
 
 ### Suggesting Enhancements
-Before suggesting an enhancement, please perform a [cursory search](https://github.com/excalith/Interactive-Git-Cheatsheet/issues) to see if the suggestion has already been submitted.
+Before suggesting an enhancement, please perform a [cursory search](https://github.com/excalith/git-cheats/issues) to see if the suggestion has already been submitted.
 
 * **User a clear descriptive title** for the suggestion
 * **Describe the current behavior** and **explain which behavior you expected to see instead** and why
 * **Do not request complicated commands** since this project is to help people get the basic commands
 
 Unsure where to begin contributing? You can start by looking through these `beginner` and `help-wanted` issues:
 
-* [Beginner issues](https://github.com/excalith/Interactive-Git-Cheatsheet/labels/beginner) - issues which should only require a few lines of code, and a test or two.
-* [Help wanted issues](https://github.com/excalith/Interactive-Git-Cheatsheet/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues.
-
-### Localization
-In order to localize this app, you only need to modify [commands.json](../assets/commands.json) file.
-
-To start localization;
-* Declare your language in `languages` with key / value first and use this convention for your localization.
-* Translations are needed in keys:
-##### GUI
-  * `search` : Search Bar placeholder
-  * `advancedCommands` : Dropdown checkbox for advanced commands
-  * `readMore` : Read More links for documentations
-  * `settings` : Settings title
-  * `options` : Command options title within cards
- ##### Cards (throughout all json file)
-  * `category` : Category title for command card
-  * `desc` : Both command and command option descriptions
+* [Beginner issues](https://github.com/excalith/git-cheats/labels/beginner) - issues which should only require a few lines of code, and a test or two.
+* [Help wanted issues](https://github.com/excalith/git-cheats/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues.
+
 
 ### Pull Requests
 While creating a Pull Request, fill out the [the required template](PULL_REQUEST_TEMPLATE.md)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,4 @@
-<!-- Filling out the template is required. You can keep it simple, but please descripe as much as you can -->
+<!-- Filling out the template is required. You can keep it simple, but please describe as much as you can -->
 ### Description of the Change
 <!-- What have you changed and why -->
 

diff --git a/.github/splash.png b/.github/splash.png
diff --git a/README.md b/README.md
@@ -1,36 +1,46 @@
-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).
+<p align="center">
+	<h1 align="center">Git Cheats • <i>Interactive Git Cheatsheet</i></h1>
+</p>
+<p align="center">
+<b>Git Cheats</b> aims to ease the pain while transitioning from sluggish GUI clients to blazing-fast terminal commands
+</p>
 
-## Getting Started
+<p align="center">
+    <img src=".github/splash.png">
+</p>
 
-First, run the development server:
 
-```bash
-npm run dev
-# or
-yarn dev
-```
+## Online
+You can find and bookmark the online version from [git-cheats.vercel.app](https://git-cheats.vercel.app)
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Local
+1. Clone this repository
+2. Run `yarn` to install dependencies
+3. Run `yarn dev` to start server
 
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+## How To Contribute
+Please feel free to contribute any way you can. Just keep in mind that you should pay attention to [CONTRIBUTE.md](.github/CONTRIBUTING.md) before contributing.
 
-[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.js`.
+That being said, you can;
+* Create issues for feature requests and issues
+* Create pull requests for any fixes / additions
+* Create pull requests for localizations
 
-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.
+## Technology
+- Hosted on [Vercel](https://vercel.com/) &hearts;
+- [Bootstrap](https://getbootstrap.com/)
+- [Next.js](https://nextjs.org/) 
+- [React](https://reactjs.org/)
+- [SWR](https://swr.vercel.app/)
 
-## Learn More
+You can find the rest in [package.json](package.json)
 
-To learn more about Next.js, take a look at the following resources:
-
-- [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.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-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.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
 
+## License
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
 
+## Other Useful Projects
+If you think there should be more, please create an issue labeled as `enhancement` and give direct link to the project.
+* [Git Init](https://pel-daniel.github.io/git-init) - Great learning tool for learning how to use commands
+* [Git - The Simple Guide](https://rogerdudler.github.io/git-guide) - Simple guide for getting started with git
+* [Learn Git Branching](https://learngitbranching.js.org) - Learn how to use branches properly
diff --git a/components/SEO/index.js b/components/SEO/index.js
@@ -1,8 +1,8 @@
 import Head from "next/head"
 
 const SEO = () => {
-	const title = "Git Cheats • Cheatsheet For Git Commands"
-	const description = "Cheatsheet for git commands"
+	const title = "Git Cheats • Interactive Git Cheatsheet"
+	const description = "Interactive cheatsheet for git commands to ease the pain while transitioning from sluggish GUI clients to blazing-fast terminal commands"
 	// const socialImage = "https://cancellek.com/social-image.png"
 
 	return (

diff --git a/components/Search/index.js b/components/Search/index.js
@@ -1,4 +1,4 @@
-import React, { useRef, useEffect, useState } from "react"
+import React, { useRef, useEffect } from "react"
 
 const Search = ({ handleSearch, handleAdvanced,...rest }) => {
 	const inputElement = useRef(null)

diff --git a/pages/_app.js b/pages/_app.js
@@ -7,6 +7,7 @@ import "../styles/code.css"
 import "../styles/footer.css"
 
 function MyApp({ Component, pageProps }) {
+	console.log("Hey there!\nInstead of peeking into the code,\nyou can find the whole project on\nhttps://github.com/excalith/git-cheats")
 	return <Component {...pageProps} />
 }