Skip to content

Commit

Permalink
Add some api info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brentgreeff authored Jan 24, 2018
1 parent ad20bbe commit 08ca58f
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

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

0 comments on commit 08ca58f

Please sign in to comment.