Skip to content

Commit

Permalink
docs: re-add install command to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredhendrickson13 authored Jul 11, 2024
1 parent 4b44699 commit b21981d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,22 @@ provide you with the information you need to configure and use the package effec
- [Swagger and OpenAPI](https://pfrest.org/SWAGGER_AND_OPENAPI/)
- [Queries and Filters](https://pfrest.org/QUERIES_AND_FILTERS/)

## Quickstart

For new users, it is recommended to refer to the links in the [Getting Started section](#getting-started) to begin. Otherwise, the install
command is included below for quick reference:

```bash
pkg-static -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.7.2-pkg-RESTAPI.pkg
```

> [!NOTE]
> You may need to customize the installation command to reference the package built for your pfSense version. Check
> the [releases page](https://github.com/jaredhendrickson13/pfsense-api/releases) to find the package built for
> your version of pfSense.
## Disclaimers

> [!CAUTION]
> This package is not affiliated or supported by Netgate or the pfSense team. This package is developed and maintained
> by the community.

0 comments on commit b21981d

Please sign in to comment.