Skip to content

Commit

Permalink
refactor: Update README.md with instructions for setting up Cloudflar…
Browse files Browse the repository at this point in the history
…e API Key and KV Namespace
  • Loading branch information
jqshuv committed Oct 15, 2024
1 parent cfeff0b commit 195ba81
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ This is an explanation of how you can get your own instance of short up and runn

Before you get started, you need to have a few things ready:

* <a href="https://github.com/jqshuv/short/fork" target="_blank">Fork</a> the repository to your own account.
* [Fork](https://github.com/jqshuv/short/fork) the repository to your own account.
* A Cloudflare API Key with the necessary permissions to create and manage workers.
* Follow the instructions <a href="https://developers.cloudflare.com/workers/ci-cd/external-cicd/github-actions/#api-token" target="_blank">here</a> to get your API Key.
* Follow the instructions [here](https://developers.cloudflare.com/workers/ci-cd/external-cicd/github-actions/#api-token) to get your API Key.
* A Cloudflare KV Namespace to store the links.
* Follow the instructions <a href="https://developers.cloudflare.com/kv/get-started/#2-create-a-kv-namespace)" target="_blank">here</a> to create a new KV Namespace. (Recommended: Select Dashboard in the documentation)
* Follow the instructions [here](https://developers.cloudflare.com/kv/get-started/#2-create-a-kv-namespace) to create a new KV Namespace. (Recommended: Select Dashboard in the documentation)


### Deployment
Expand All @@ -131,7 +131,7 @@ Before you get started, you need to have a few things ready:
2. Activate GitHub Actions in your repository. (Settings > Actions > General > Allow all actions and reusable workflows > Save)
3. Run the workflow `Deploy` manually. (Actions > Deploy > Run workflow > Run workflow)

##### 🚀 All done! How simple huh? Now you can see your worker active [here](https://dash.cloudflare.com/?to=/:account/workers-and-pages) in your Cloudflare dashboard.
### 🚀 All done! How simple huh? Now you can see your worker active [here](https://dash.cloudflare.com/?to=/:account/workers-and-pages) in your Cloudflare dashboard.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down

0 comments on commit 195ba81

Please sign in to comment.