Skip to content

Commit b21981d

Browse files
docs: re-add install command to README
1 parent 4b44699 commit b21981d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,22 @@ provide you with the information you need to configure and use the package effec
2424
- [Swagger and OpenAPI](https://pfrest.org/SWAGGER_AND_OPENAPI/)
2525
- [Queries and Filters](https://pfrest.org/QUERIES_AND_FILTERS/)
2626

27+
## Quickstart
28+
29+
For new users, it is recommended to refer to the links in the [Getting Started section](#getting-started) to begin. Otherwise, the install
30+
command is included below for quick reference:
31+
32+
```bash
33+
pkg-static -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.7.2-pkg-RESTAPI.pkg
34+
```
35+
36+
> [!NOTE]
37+
> You may need to customize the installation command to reference the package built for your pfSense version. Check
38+
> the [releases page](https://github.com/jaredhendrickson13/pfsense-api/releases) to find the package built for
39+
> your version of pfSense.
40+
41+
## Disclaimers
42+
2743
> [!CAUTION]
2844
> This package is not affiliated or supported by Netgate or the pfSense team. This package is developed and maintained
2945
> by the community.

0 commit comments

Comments
 (0)