Skip to content

Commit

Permalink
Merge pull request #64 from ReputationVIP/improve-readme-readability
Browse files Browse the repository at this point in the history
Simplify readme readability
  • Loading branch information
tejerka committed Aug 31, 2018
2 parents 8a22913 + 01fb851 commit b8e1770
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,29 @@

Mockservr is an API mocking system, allowing to configure endpoints, specifying requests details and responses.

Some of Mockservr key features:

* YAML or JSON endpoint configuration
* Ability to use Apache Velocity Template files to dynamically adapt responses to requests parameters
* Available under docker image, see dockerhub to be easily integrated into a development / test stack
* Official image maintained under docker hub (![docker image](https://raw.githubusercontent.com/ReputationVIP/mockservr/master/docs/images/docker-logo.png) [rvip/mockservr](https://hub.docker.com/r/rvip/mockservr/)) to ease integration into a development or test stack

Mockservr is designed to be as user-friendly as possible, hence it can be integrated into an existing stack really quickly, immediately providing a way to mock APIs.

## Quickstart

### Requirements

* `docker`

### Docker Container

![docker](https://raw.githubusercontent.com/ReputationVIP/mockservr/master/docs/images/docker-logo.png) [rvip/mockservr](https://hub.docker.com/r/rvip/mockservr/)
### Run Mockservr with Docker

```
docker run -p 8080:80 -p 4580:4580 -v /mocks-directory:/usr/src/app/mocks rvip/mockservr
```

### Mockservr browser
### Access Mockservr browser

Mockservr comes with an embedded web based object browser.

Default web browser url : [http://localhost:4580](http://localhost:4580).

### Hello World
### Run Hello World

Put sample config mock below in `/mocks-directory` on your host.

Expand Down

0 comments on commit b8e1770

Please sign in to comment.