Add badges, History.md and Releasing.md (#23)

This commit is contained in:
Connor Prussin 2017-07-10 12:38:56 -07:00 committed by GitHub
parent cfcd867729
commit bf98eea8fc
3 changed files with 30 additions and 0 deletions

5
History.md Normal file
View File

@ -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

View File

@ -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

21
Releasing.md Normal file
View File

@ -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<new version number>".
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).