Skip to content

Commit 653a0db

Browse files
author
Colin Wahl
committed
fix typo in README. Fix repository links to point to purescript-contrib. Add line about installing npm packages
1 parent d5f3a98 commit 653a0db

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GitHub Actions Toolkit
22

3-
[![CI](https://github.com/colinwahl/purescript-github-actions-toolkit/workflows/CI/badge.svg?branch=main)](https://github.com/colinwahl/purescript-github-actions-toolkit/actions?query=workflow%3ACI+branch%3Amain)
4-
[![Release](http://img.shields.io/github/release/colinwahl/purescript-github-actions-toolkit.svg)](https://github.com/colinwahl/purescript-github-actions-toolkit/releases)
3+
[![CI](https://github.com/purescript-contrib/purescript-github-actions-toolkit/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-github-actions-toolkit/actions?query=workflow%3ACI+branch%3Amain)
4+
[![Release](http://img.shields.io/github/release/purescript-contrib/purescript-github-actions-toolkit.svg)](https://github.com/purescript-contrib/purescript-github-actions-toolkit/releases)
55
[![Pursuit](http://pursuit.purescript.org/packages/purescript-github-actions-toolkit/badge)](http://pursuit.purescript.org/packages/purescript-github-actions-toolkit)
66
[![Maintainer: colinwahl](https://img.shields.io/badge/maintainer-colinwahl-teal.svg)](http://github.com/colinwahl)
77

@@ -15,6 +15,12 @@ Install GitHub Actions Toolkit with [Spago](https://github.com/purescript/spago)
1515
spago install github-actions-toolkit
1616
```
1717

18+
You will also need to install the npm packages for any bindings that you are using. For example, if you use functions exported from `GitHub.Actions.Core`, then you need to install the `@actions/core` npm package:
19+
20+
```sh
21+
npm install @actions/core
22+
```
23+
1824
## Quick start
1925

2026
An Action is an `action.yml` file pair with a Node script.
@@ -41,7 +47,7 @@ Use `which` to check that a tool is installed, and set the job to failed if it i
4147
```purescript
4248
main :: Effect Unit
4349
main = do
44-
result <- runExcaptT (IO.which { tool: "spago", check: true })
50+
result <- runExceptT (IO.which { tool: "spago", check: true })
4551
case result of
4652
Left err ->
4753
Core.error "spago not found"
@@ -82,14 +88,14 @@ For a usage example, see the [Hello World PureScript Action template](https://gi
8288

8389
If you get stuck, there are several ways to get help:
8490

85-
- [Open an issue](https://github.com/colinwahl/purescript-github-actions-toolkit/issues) if you have encountered a bug or problem.
91+
- [Open an issue](https://github.com/purescript-contrib/purescript-github-actions-toolkit/issues) if you have encountered a bug or problem.
8692
- [Search or start a thread on the PureScript Discourse](https://discourse.purescript.org) if you have general questions. You can also ask questions in the `#purescript` and `#purescript-beginners` channels on the [Functional Programming Slack](https://functionalprogramming.slack.com) ([invite link](https://fpchat-invite.herokuapp.com/)).
8793

8894
## Contributing
8995

9096
You can contribute to GitHub Actions Toolkit in several ways:
9197

92-
1. If you encounter a problem or have a question, please [open an issue](https://github.com/colinwahl/purescript-github-actions-toolkit/issues). We'll do our best to work with you to resolve or answer it.
98+
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-github-actions-toolkit/issues). We'll do our best to work with you to resolve or answer it.
9399

94100
2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./.github/CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
95101

0 commit comments

Comments
 (0)