Skip to content
This repository was archived by the owner on Jun 3, 2023. It is now read-only.

Commit 48f85b1

Browse files
author
Victor Navarro
committed
docs: explain os specifics
1 parent 5cae7b1 commit 48f85b1

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<div align="center">
22
<h1>🔥 setup-firebase</h1>
33
<p>Setup firebase-tools CLI for multiple steps</p>
4+
<p align="center">
5+
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/pocket-studios/action-setup-firebase/ci">
6+
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/pocket-studios/action-setup-firebase">
7+
</p>
48
</div>
59

610
## 🧠 Why
@@ -19,12 +23,18 @@ jobs:
1923
runs-on: ubuntu-latest
2024
steps:
2125
- uses: actions/checkout@v2
22-
- uses: actions/setup-node@v1
26+
- uses: actions/setup-node@v1 # This is optional on linux and macOS
2327
- uses: pocket-studios/action-setup-firebase@v1
2428
with:
2529
firebase-token: YOUR_TOKEN
2630
```
2731
32+
By default, it will try to download the package from npm,
33+
if it fails because npm is not installed, or it doesn't have sufficient permissions,
34+
the action will fallback to download it using `curl`.
35+
36+
If you are running it on Windows you will need to use actions/setup-node before in order to work.
37+
2838
## ⚙ Inputs
2939

3040
**Name**|**Description**|**Required**

0 commit comments

Comments
 (0)