Skip to content

Commit ecf9f64

Browse files
committed
chore: updated docs readme && bump cargo toml version
Signed-off-by: rafaeljohn9 <[email protected]>
1 parent 6e4d6da commit ecf9f64

File tree

3 files changed

+24
-27
lines changed

3 files changed

+24
-27
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22

33
name = "gh-templates"
4-
version = "0.1.31"
4+
version = "0.1.32"
55
edition = "2021"
66
authors = ["John Kagunda [email protected]"]
77
description = "A template project for GitHub-related utilities."

docs/README.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,38 @@
1-
# Website
1+
# gh-templates Documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
Welcome to the documentation for **gh-templates**—your command-line companion for scaffolding GitHub templates with ease.
44

5-
## Installation
5+
This documentation explains how to use `gh-templates` to quickly add and manage templates for issues, pull requests, licenses, and `.gitignore` files in your repositories. Whether you're starting a new project or standardizing existing ones, these docs will guide you through installation, usage, and customization.
66

7-
```bash
8-
yarn
9-
```
10-
11-
## Local Development
12-
13-
```bash
14-
yarn start
15-
```
7+
## About gh-templates
168

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
9+
`gh-templates` streamlines the process of adding professional templates to your GitHub repositories. With a single command, you can:
1810

19-
## Build
11+
- Add structured **issue templates** for better bug reports and feature requests
12+
- Create standardized **pull request templates** to improve code review workflows
13+
- Add popular **license templates** to your projects
14+
- Generate language-specific **.gitignore** files to keep your repos clean
2015

21-
```bash
22-
yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
16+
## Using the Documentation
2617

27-
## Deployment
18+
- **Getting Started**: Learn how to install and set up `gh-templates`
19+
- **Usage Guides**: Step-by-step instructions for each template type
20+
- **Customization**: Tips for customizing templates and output locations
21+
- **Reference**: Detailed command and option documentation
2822

29-
Using SSH:
23+
You can view and edit this documentation locally:
3024

3125
```bash
32-
USE_SSH=true yarn deploy
26+
yarn
27+
yarn start
3328
```
3429

35-
Not using SSH:
30+
To build a static version for deployment:
3631

3732
```bash
38-
GIT_USER=<Your GitHub username> yarn deploy
33+
yarn build
3934
```
4035

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
36+
For deployment instructions and more, see the additional guides in this directory.
37+
38+
Ready to scaffold your GitHub templates? Start with the [Introduction](./intro.md) or jump to the [Installation Guide](./installation.md).

0 commit comments

Comments
 (0)