Initial project setup

Author: GokulnathP

README.md

@@ -1,68 +1,45 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# git-co-commit
 
-## Available Scripts
+When a pair or multiple developers work on git projects, there is a convention that allows us to document our co-authors in the commit message. However, adding the co-authorship information on every single commit is painful. <br><br>
+Install git-co-commit package to use just a single commit to add all the team members that worked in the project as co-authors. <br><br>
+Each co-author will be added to the commit message, so that they are also credited in the github contributions view!
 
-In the project directory, you can run:
+### Before pairing
 
-### `yarn start`
+![before pairing](https://raw.githubusercontent.com/bdo/gitpair/master/docs/before-gitpair.png)
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+### After pairing
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+![after pairing](https://raw.githubusercontent.com/bdo/gitpair/master/docs/after-gitpair.png)
 
-### `yarn test`
+<br>
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+## Install it globally,
 
-### `yarn build`
+```bash
+npm i -g git-co-commit
+```
 
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
+#### Use it globally,
 
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
+```bash
+commit
+```
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+## Install it locally,
 
-### `yarn eject`
+```bash
+npm i git-co-commit
+```
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+#### For using it locally, specify following in scripts of package.json
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+```js
+"commit": "commit"
+```
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+#### For running it
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `yarn build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+```bash
+npm run commit
+```