From 08ca58fe86fd77bbd259b2edf5f87bbcf24c3222 Mon Sep 17 00:00:00 2001 From: Brent Greeff Date: Wed, 24 Jan 2018 22:26:29 +0700 Subject: [PATCH] Add some api info to readme --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93901af..bc41c70 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Build Status](https://semaphoreci.com/api/v1/brentgreeff/basic_rails_5_api/branches/master/badge.svg)](https://semaphoreci.com/brentgreeff/basic_rails_5_api) -# Group events +# Events Basic Rails API for creating, updating and deleting Events. @@ -23,3 +23,24 @@ Please run `guard` when changing code. press [enter] to run all tests. The tests should be self documenting. + +## API + +Add user +> POST /users + +Login +> POST /authentications + +Event list +> GET /events + +Create Event +> POST /events + +Update Event +> PATCH /events/ID + +Delete Event +> DELETE /events/ID +