Skip to content

Commit dcf27ab

Browse files
committed
Release v0.1.0
- Add RELEASES.md - Add encouragement to use vendoring and warning regarding breaking changes
1 parent ba39d59 commit dcf27ab

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,11 @@ We're working on implementing other storage mechanisms, so you don't have to run
7272
Usage
7373
-----
7474

75-
In both examples we create a web service that responds to requests to `/ping` with "pong".
75+
Get the package with `go get -u github.com/philippgille/ln-paywall/pay`.
76+
77+
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).
78+
79+
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".
7680

7781
### net/http HandlerFunc
7882

RELEASES.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Releases
2+
========
3+
4+
All notable changes to this project will be documented in this file.
5+
6+
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).
7+
8+
vNext
9+
-----
10+
11+
v0.1.0 (2018-07-02)
12+
-------------------
13+
14+
Initial release after working on the project during the "Chainhack 3" [Blockchain hackathon](https://blockchain-hackathon.com/).
15+
16+
- Go middlewares for:
17+
- [net/http](https://golang.org/pkg/net/http/) `HandlerFunc`
18+
- [net/http](https://golang.org/pkg/net/http/) `Handler`
19+
- Compatible with routers like [gorilla/mux](https://github.com/gorilla/mux) and [chi](https://github.com/go-chi/chi)
20+
- [Gin](https://github.com/gin-gonic/gin)
21+
- Supported Lightning Network node:
22+
- [lnd](https://github.com/lightningnetwork/lnd)
23+
- Supported storage:
24+
- [Redis](https://redis.io/)

0 commit comments

Comments
 (0)