Skip to content

Commit

Permalink
Release v0.1.0
Browse files Browse the repository at this point in the history
- Add RELEASES.md
- Add encouragement to use vendoring and warning regarding breaking changes
  • Loading branch information
philippgille committed Jul 2, 2018
1 parent ba39d59 commit dcf27ab
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ We're working on implementing other storage mechanisms, so you don't have to run
Usage
-----

In both examples we create a web service that responds to requests to `/ping` with "pong".
Get the package with `go get -u github.com/philippgille/ln-paywall/pay`.

We strongly encourage you to use vendoring, because as long as `ln-paywall` is version `0.x`, breaking changes may be introduced in new versions, including changes to the package name / import path. The project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html) and all notable changes to this project are documented in [RELEASES.md](https://github.com/philippgille/ln-paywall/blob/master/RELEASES.md).

The best way to see how to use `ln-paywall` is by example. In the below examples we create a web service that responds to requests to `/ping` with "pong".

### net/http HandlerFunc

Expand Down
24 changes: 24 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Releases
========

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

vNext
-----

v0.1.0 (2018-07-02)
-------------------

Initial release after working on the project during the "Chainhack 3" [Blockchain hackathon](https://blockchain-hackathon.com/).

- Go middlewares for:
- [net/http](https://golang.org/pkg/net/http/) `HandlerFunc`
- [net/http](https://golang.org/pkg/net/http/) `Handler`
- Compatible with routers like [gorilla/mux](https://github.com/gorilla/mux) and [chi](https://github.com/go-chi/chi)
- [Gin](https://github.com/gin-gonic/gin)
- Supported Lightning Network node:
- [lnd](https://github.com/lightningnetwork/lnd)
- Supported storage:
- [Redis](https://redis.io/)

0 comments on commit dcf27ab

Please sign in to comment.