Skip to content

Commit 3cd4c7b

Browse files
committed
Add README.md
1 parent 8b13ddd commit 3cd4c7b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Codegate
2+
3+
Codegate is a simple and easy-to-use pre-commit tool that helps automate checks before committing your code.
4+
5+
## Installation
6+
7+
1. Download the tool.
8+
2. Move the downloaded file to /usr/local/bin/ and rename it to codegate.
9+
10+
11+
## Initialization and Usage
12+
1. Run the following command to initialize Codegate in your project:
13+
```
14+
codegate --mode init
15+
```
16+
17+
2. After running the command, a .codegate folder will be created in your project, containing a pre-commit file. You can edit this file to configure the checks you want to run before each commit.
18+
19+
20+
21+
3. From now on, before every commit, Git will automatically run the commands specified in the pre-commit file.

0 commit comments

Comments
 (0)