Skip to content

Commit 861299e

Browse files
committed
chore: Updated README. Updated stale links and refactored Gitforge to Gitcraft
Signed-off-by: rafaeljohn9 <rafaeljohb@gmail.com>
1 parent c98b7b1 commit 861299e

File tree

1 file changed

+23
-31
lines changed

1 file changed

+23
-31
lines changed

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
1-
# GitForge (formerly GH Templates)
1+
# Gitcraft (formerly GH Templates)
22

33
> [!NOTE]
44
> This project is currently being renamed and restructured.
55
> Some documentation and package references may still use the old name
66
> **`gh-templates`** until the migration is complete.
77
8-
GitForge is a developer-friendly toolkit for managing and applying reusable **GitHub repository templates** — including **Issue Templates**, **Pull Request Templates**, **.gitignore files**, **Licenses**, and more.
8+
Gitcraft is a developer-friendly toolkit for managing and applying reusable **GitHub repository templates** — including **Issue Templates**, **Pull Request Templates**, **.gitignore files**, **Licenses**, and more.
99
It helps you quickly scaffold standard project configurations without repetitive manual setup.
1010

1111
---
1212

13+
[![GitHub Release](https://img.shields.io/github/v/release/Byte-Barn/gitcraft?label=GitHub%20Release)](https://github.com/Byte-Barn/gitcraft/releases)
14+
[![License](https://img.shields.io/github/license/Byte-Barn/gitcraft?label=License)](LICENSE)
1315

14-
[![GitHub Release](https://img.shields.io/github/v/release/rafaeljohn9/gh-templates?label=GitHub%20Release)](https://github.com/rafaeljohn9/gh-templates/releases)
15-
[![License](https://img.shields.io/github/license/rafaeljohn9/gh-templates?label=License)](LICENSE)
16+
[![Crates.io](https://img.shields.io/crates/v/gitcraft?label=crates.io)](https://crates.io/crates/gitcraft)
17+
[![Crate Downloads](https://img.shields.io/crates/d/gitcraft?label=downloads)](https://crates.io/crates/gitcraft)
1618

17-
[![Crates.io](https://img.shields.io/crates/v/gh-templates?label=crates.io)](https://crates.io/crates/gh-templates)
18-
[![Crate Downloads](https://img.shields.io/crates/d/gh-templates?label=downloads)](https://crates.io/crates/gh-templates)
19+
[![PyPI version](https://img.shields.io/pypi/v/gitcraft?label=PyPI)](https://pypi.org/project/gitcraft/)
20+
[![PyPI downloads](https://static.pepy.tech/personalized-badge/gitcraft?period=month&units=international_system&left_color=black&right_color=blue&left_text=PyPI%20Downloads)](https://pepy.tech/project/gitcraft)
1921

20-
[![PyPI version](https://img.shields.io/pypi/v/gh-templates?label=PyPI)](https://pypi.org/project/gh-templates/)
21-
[![PyPI downloads](https://static.pepy.tech/personalized-badge/gh-templates?period=month&units=international_system&left_color=black&right_color=blue&left_text=PyPI%20Downloads)](https://pepy.tech/project/gh-templates)
22-
23-
[![npm version](https://img.shields.io/npm/v/gh-templates?label=npm)](https://www.npmjs.com/package/gh-templates)
24-
[![npm downloads](https://img.shields.io/npm/dm/gh-templates?label=npm%20downloads)](https://www.npmjs.com/package/gh-templates)
22+
[![npm version](https://img.shields.io/npm/v/gitcraft?label=npm)](https://www.npmjs.com/package/gitcraft)
23+
[![npm downloads](https://img.shields.io/npm/dm/gitcraft?label=npm%20downloads)](https://www.npmjs.com/package/gitcraft)
2524

2625
---
2726

2827
## About
2928

30-
**GitForge** is designed to simplify repository setup and management by offering ready-to-use templates and configuration files.
31-
Instead of manually creating `.gitignore`, license, and issue templates for each new project, GitForge helps you **generate them instantly** from trusted sources.
29+
**Gitcraft** is designed to simplify repository setup and management by offering ready-to-use templates and configuration files.
30+
Instead of manually creating `.gitignore`, license, and issue templates for each new project, Gitcraft helps you **generate them instantly** from trusted sources.
3231

3332
It works across different ecosystems and supports multiple package managers — **Rust (Cargo)**, **Python (PyPI)**, and **Node (npm)**.
3433

@@ -39,13 +38,15 @@ It works across different ecosystems and supports multiple package managers —
3938
We welcome contributions from everyone — whether you’re improving templates, fixing docs, or enhancing CLI commands.
4039

4140
Most of the repository consists of:
41+
4242
- **YAML files** – for GitHub workflows
4343
- **Markdown files** – for templates & documentation
4444
- **License files** – for open source compliance
4545

4646
Rust, Python, or Node are only used for the CLI layer, so you can contribute without deep language knowledge.
4747

4848
You can help by:
49+
4950
- Opening issues
5051
- Suggesting new templates
5152
- Improving command UX or documentation
@@ -67,33 +68,30 @@ You can help by:
6768

6869
### Quick Install (Recommended)
6970

70-
#### Using npm:
71+
#### Using npm
72+
7173
```bash
7274
npm install -g gitcraft
7375
```
7476

75-
#### Using pip:
77+
#### Using pip
7678

7779
```
7880
pip install gitcraft
7981
```
8082

81-
82-
#### Using Cargo:
83+
#### Using Cargo
8384

8485
```
8586
cargo install gitcraft
8687
```
8788

88-
89-
9089
### Example Usage
9190

9291
> [!NOTE]
9392
> Some commands may still appear under the old name gh-templates
9493
> until the migration is finalized.
9594
96-
9795
#### New Command Syntax
9896

9997
```sh
@@ -120,33 +118,27 @@ gh-templates gitignore add python
120118
gh-templates issue add bug
121119
```
122120

123-
124121
### Migration Notice
125122

126-
- GitForge is the next evolution of GH Templates — bringing a cleaner command structure, modern UX, and broader language support.
123+
- Gitcraft is the next evolution of GH Templates — bringing a cleaner command structure, modern UX, and broader language support.
127124
- You may still see references to gh-templates across:
128125
- Code imports
129126
- Package registries (npm, PyPI, crates.io)
130127
- Docs and badges
131128

132-
133-
134-
135129
These will be updated as the migration completes.
136130

137-
138-
# License:
131+
# License
139132

140133
- Licensed under the Apache 2.0 License.
141134

142-
143135
---
144136

145-
### Key Highlights:
146-
- Renamed to **GitForge**, with a clear **transition notice**.
137+
### Key Highlights
138+
139+
- Renamed to **Gitcraft**, with a clear **transition notice**.
147140
- Updated **badges, usage examples**, and **command syntax**.
148141
- Introduced new **natural language CLI syntax** (`gitcraft add gitignore python`).
149142
- Kept **backward compatibility** note for developers still using `gh-templates`.
150143

151144
---
152-

0 commit comments

Comments
 (0)