minor fixes to README for clarity and swapped out references to TAAR for
TAAR lite
This commit is contained in:
Родитель
2f4e4f0ceb
Коммит
0a153be022
11
README.md
11
README.md
|
@ -1,10 +1,8 @@
|
||||||
# Taar Api
|
# TAAR API-lite
|
||||||
|
|
||||||
[![CircleCI](https://circleci.com/gh/mozilla/taar-api-lite.svg?style=shield)](https://circleci.com/gh/mozilla/taar-api-lite)
|
[![CircleCI](https://circleci.com/gh/mozilla/taar-api-lite.svg?style=shield)](https://circleci.com/gh/mozilla/taar-api-lite)
|
||||||
[![codecov](https://codecov.io/gh/mozilla/taar-api-lite/branch/master/graph/badge.svg)](https://codecov.io/gh/mozilla/taar-api-lite)
|
[![codecov](https://codecov.io/gh/mozilla/taar-api-lite/branch/master/graph/badge.svg)](https://codecov.io/gh/mozilla/taar-api-lite)
|
||||||
|
|
||||||
Dockerflow cookiecutter contains all the boilerplate you need to create a Dockerflow-compliant project.
|
|
||||||
|
|
||||||
|
|
||||||
## Instructions for development
|
## Instructions for development
|
||||||
|
|
||||||
|
@ -17,18 +15,17 @@ The target environment for this project follows the [dockerflow](https://github.
|
||||||
In order to run it correctly, a number of environment variables needs to be set up.
|
In order to run it correctly, a number of environment variables needs to be set up.
|
||||||
The full list of variables can be found in the web section of the docker-compose.yml file.
|
The full list of variables can be found in the web section of the docker-compose.yml file.
|
||||||
From a services standpoint, this project requires:
|
From a services standpoint, this project requires:
|
||||||
- a Postgres db to store the application data, defined by DATABASE_URL
|
|
||||||
- an optional Redis cache service, defined by CACHE_URL
|
- an optional Redis cache service, defined by CACHE_URL
|
||||||
|
|
||||||
### Updating Taar
|
### Updating Taar
|
||||||
|
|
||||||
The core of taar-service lives in the [mozilla-taarlite](https://pypi.python.org/pypi/mozilla-taarlite) python package.
|
The core of taar-service lives in the [mozilla-taarlite](https://pypi.python.org/pypi/mozilla-taarlite) python package.
|
||||||
These are the steps required to deploy a new version of mozilla-taar on taar-api-lite using [hashin](https://pypi.python.org/pypi/hashin):
|
These are the steps required to deploy a new version of mozilla-taarlite on taar-api-lite using [hashin](https://pypi.python.org/pypi/hashin):
|
||||||
|
|
||||||
From the root of the repository:
|
From the root of the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hashin mozilla-taarlite==<major>.<minor>.<patch>
|
hashin mozilla-taarlite==<major>.<minor>.<patch>
|
||||||
```
|
```
|
||||||
Then open a pull request with the changes to requirements.txt. Once it's merged to master, the taar api dev service will automatically
|
Then open a pull request with the changes to requirements.txt. Once
|
||||||
update.
|
it's merged to master, the service will automatically update.
|
||||||
|
|
Загрузка…
Ссылка в новой задаче