Skip to content

Commit

Permalink
Merge pull request #1 from atelierdisko/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
francawinter authored Jul 23, 2020
2 parents a030c11 + fd88577 commit eb69ca4
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@

API to create expiring secrets with passphrase protection. Used by client application [Sesame](https://github.com/atelierdisko/sesame).


## Local development
```shell script
1. Download repository
2. Start [Docker](https://www.docker.com/get-started)
3. Start Sesame Docker container with
```
docker-compose up
```

The container is now up and running.

To see Sesame in your browser, additionally download the [Sesame client application](https://github.com/atelierdisko/sesame)

## Endpoints

[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Sesame&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fatelierdisko%2Fsesame-api%2Fmaster%2Finsomnia.json)
Expand Down

0 comments on commit eb69ca4

Please sign in to comment.