Skip to content

Commit

Permalink
✍️ update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thiskevinwang committed Feb 11, 2023
1 parent 3a4dd4e commit d6d1ea8
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
![Screenshot of waypoint-plugin-nixpacks in HCP Waypoint](https://user-images.githubusercontent.com/26389321/218119583-9dabe325-9295-4098-90ac-b9f32ccb7b74.png)

---

# waypoint-plugin-nixpacks

![CleanShot 2023-02-10 at 09 39 09@2x](https://user-images.githubusercontent.com/26389321/218119583-9dabe325-9295-4098-90ac-b9f32ccb7b74.png)
This [Waypoint][waypoint] plugin builds OCI images using [`nixpacks`][nixpacks].

This plugin only implements the [builder][builder] interface.

This [Waypoint][waypoint] plugin builds OCI images using [nixpacks][nixpacks].
## Building

Check out the [examples](./examples) folder for usage examples.
To build this plugin, run `make`. (See [`Makefile`](./Makefile) for more details.)
A plugin binary will be built and outputted to the [`./bin`](./bin) folder as well as copied into the example project folder.

This requires the following packages:

- `go`
- `protoc`
- `protoc-gen-go`

## Usage

The Waypoint runner (such as the CLI) that ends up picking up a job (such as `waypoint build`) will need [`nixpacks`][nixpacks] installed.

Check out the [examples](./examples) folder for usage examples.

[waypoint]: https://developer.hashicorp.com/waypoint
[builder]: https://developer.hashicorp.com/waypoint/docs/extending-waypoint/plugin-interfaces/builder
[waypoint]: https://github.com/hashicorp/waypoint
[nixpacks]: https://github.com/railwayapp/nixpacks

0 comments on commit d6d1ea8

Please sign in to comment.