From dcf27ab514131d7a3c6fdff8ecfba52a8f4722e2 Mon Sep 17 00:00:00 2001 From: Philipp Gille Date: Mon, 2 Jul 2018 16:07:53 +0200 Subject: [PATCH] Release v0.1.0 - Add RELEASES.md - Add encouragement to use vendoring and warning regarding breaking changes --- README.md | 6 +++++- RELEASES.md | 24 ++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 RELEASES.md diff --git a/README.md b/README.md index 61ecfc4..caf9507 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/RELEASES.md b/RELEASES.md new file mode 100644 index 0000000..ca4f409 --- /dev/null +++ b/RELEASES.md @@ -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/)