diff --git a/History.md b/History.md new file mode 100644 index 0000000..c01abc5 --- /dev/null +++ b/History.md @@ -0,0 +1,5 @@ +unreleased +========== +- Basic support for routing with full string matched routes +- Allow routes to set headers, status, and body +- Support Get, Post, Put, and Delete HTTP methods diff --git a/Readme.md b/Readme.md index 67b609d..5874981 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,9 @@ # HTTPure +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cprussin/purescript-httpure/master/License) +[![Latest release](http://img.shields.io/github/release/cprussin/purescript-httpure.svg)](https://github.com/cprussin/purescript-httpure/releases) +[![Build Status](https://travis-ci.org/cprussin/purescript-httpure.svg?branch=master)](https://travis-ci.org/cprussin/purescript-httpure) + A purescript HTTP server framework. ## Status diff --git a/Releasing.md b/Releasing.md new file mode 100644 index 0000000..3b9977c --- /dev/null +++ b/Releasing.md @@ -0,0 +1,21 @@ +# HTTPure Releasing Guide + +1. Check out the branch you will be releasing (generally `master`, but sometimes + an older release series branch). Ensure all relevant commits and PRs have + been merged. +2. Update [History.md](History.md) by changing "unreleased" to the new + version/date. Example diff: +```diff +-unreleased +-========== ++1.0.0 / 2017-07-10 ++================== +``` +3. Commit your update to [History.md](History.md). Use the message "Release + notes for v". +4. Run `pulp version` in the project root. This will check the project for any + issues and create a new version tag and empty checkpoint commit. +5. Push the release notes and version commit and version tag. +6. If you are pushing a non-patch release, create and push a branch named with + the version series, i.e. `v0.1.x`. +7. [Create the release on github](https://github.com/cprussin/purescript-httpure/releases/new).