Skip to content

Commit

Permalink
add docs and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
iferencik committed Jan 22, 2022
1 parent 1b4eed7 commit d0bb1dc
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 UNDP-Data

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,21 @@ we used the dockerized version of tippecanoe as it is relatively straightforward


## Hands on
docker needs to be installed
The pipeline is deployed as a Docker image.

### 1. Create an .env file holding the Azure credentials
```bash
mkdir sidspipeline
cd sidspipeline

```
using you favourite editor create a .env text file and add

SAS_SIDS_CONTAINER=value

where value is an full Azure SAS URL



### 2. Download the docker image

Expand Down

0 comments on commit d0bb1dc

Please sign in to comment.