Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lucetrez committed Aug 15, 2024
1 parent 2438dc2 commit 7b0f4a3
Showing 1 changed file with 1 addition and 50 deletions.
51 changes: 1 addition & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,59 +4,10 @@ Welcome to the **glnk-template** repository! This template serves as the foundat

## Features

- **HTML Generator:** Automatically generates HTML pages based on the `glnk.json` file.
- **HTML Generator:** Automatically generates HTML pages based on your custom URL map.
- **GitHub Pages Integration:** Seamless deployment to GitHub Pages.
- **Automated Workflows:** Includes a GitHub Actions workflow for continuous deployment.

## Getting Started

### Prerequisites

- Fork this template repository to our organization.

### Setup Instructions

1. **Fork the Repository:**
- Fork this repository to your GitHub account.

2. **Clone Your Fork:**
- Clone the forked repository to your local machine:
```bash
git clone https://github.com/<your-username>/glnk-template.git
cd glnk-template
```

3. **Customize `glnk.json`:**
- Update the `glnk.json` file with your go link mappings. Example structure:
```json
{
"/short-link-1": "https://example.com/long-url-1",
"/short-link-2": "https://example.com/long-url-2"
}
```

4. **Update CNAME File:**
- Update the `CNAME` file with your `<username>.glnk.dev` subdomain:
```
<username>.glnk.dev
```

6. **Push Changes:**
- Commit and push your changes to the main branch:
```bash
git add .
git commit -m "Initial commit with custom go links"
git push origin main
```

7. **Enable GitHub Pages:**
- Go to the repository settings on GitHub.
- Under the "Pages" section, set the source to the `GitHub Actions`.

## GitHub Actions Workflow

This template includes a GitHub Actions workflow that automatically deploys the generated HTML pages to GitHub Pages. The workflow is defined in the `.github/workflows/static.yml` file.

## Contribution Guidelines

We welcome contributions from everyone. Here are some ways you can contribute:
Expand Down

0 comments on commit 7b0f4a3

Please sign in to comment.