Skip to content

Commit

Permalink
Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
0xRy4n authored Feb 21, 2024
1 parent f7c5b15 commit d8df2ad
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Unlike similar repositories, the automation within this repository automatically

### Usage

1. Clone the repository as is, or copy it's entire contents barring this README and the LICENSE file into your repository.
1. Clone the repository as is, create a new repository from this template, or copy it's entire contents barring this README and the LICENSE file into your repository.
2. You must setup your repository with a `SEGMENT_TOKEN` secret containing an API key for the Segment Public API.

The repository has three directories representing the different types of Segment Functions:
Expand All @@ -29,4 +29,4 @@ You must place your files into the correct folder that corresponds with the func

The automation within `.github/workflows/updateOrCreateFunction.js` will attempt to see if there is a matching function within segment based on the function name and type. If yes, it will update that function. If no, it will create a new function. Afterwards, it will deploy the function.

By default the `main.yml` is configured to do this on the `main` or `master` branches.
By default the `main.yml` is configured to do this on the `main` or `master` branches.

0 comments on commit d8df2ad

Please sign in to comment.