Skip to content

Commit

Permalink
Remove install.sh and improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
shivammathur committed Sep 24, 2019
1 parent 3b52fba commit f9f94a7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
7 changes: 0 additions & 7 deletions .github/workflows/install.sh

This file was deleted.

24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Country City API
[![Build Status](https://travis-ci.org/shivammathur/countrycity.svg?branch=master)](https://travis-ci.org/shivammathur/countrycity)
[![Code Climate](https://codeclimate.com/github/shivammathur/countrycity/badges/gpa.svg)](https://codeclimate.com/github/shivammathur/countrycity)
[![Coverage Status](https://coveralls.io/repos/github/shivammathur/countrycity/badge.svg?branch=master)](https://coveralls.io/github/shivammathur/countrycity?branch=master)
[![codecov](https://codecov.io/gh/shivammathur/countrycity/branch/master/graph/badge.svg)](https://codecov.io/gh/shivammathur/countrycity)
[![License](https://poser.pugx.org/shivammathur/countrycity/license)](https://packagist.org/packages/shivammathur/countrycity)
[![License](https://poser.pugx.org/shivammathur/countrycity/license)](license.md)
[![Support me on Patreon](https://shivammathur.com/badges/patreon.svg)](https://www.patreon.com/shivammathur)
[![Support me on Paypal](https://shivammathur.com/badges/paypal.svg)](https://www.paypal.me/shivammathur)
[![Get Help on codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/shivammathur?utm_source=github&utm_medium=button&utm_term=shivammathur&utm_campaign=github)

Country City API is a REST API to get a list of all the countries in the world. It can also be used to get a list of all the cities in a country.

### Installing the API
### :zap: Installing the API

- Download this API using [composer](https://getcomposer.org/download/) by executing the command below.
```bash
Expand All @@ -19,7 +21,7 @@ composer create-project shivammathur/countrycity countrycity "master-dev" --pref
```
- You are all set.

### Rest API Features
### :sparkles: Rest API Features
- Built using Slim micro framework.
- Caching enabled with following headers
- ETag
Expand All @@ -28,24 +30,28 @@ composer create-project shivammathur/countrycity countrycity "master-dev" --pref
- Fast and lightweight API
- PSR 7 Complaint

### API Endpoints
### :hash: API Endpoints

- Get All Countries
All API responses are in `json` format.

- Get the list of all countries
```
/countries
```

- Get All Cities in a Country
- Get the list all cities in a country
```
/cities/{countryName}
```

### Error Format
### :wrench: Error Format

If there is an error in the API, you will get an error in `json` format as response
```json
{"error":"true", "message": "error message here"}
```

### Testing
### :rotating_light: Testing
```bash
vendor/bin/phpunit --configuration phpunit.xml.dist
```

0 comments on commit f9f94a7

Please sign in to comment.