Skip to content

Commit 83a59c2

Browse files
authored
Update README formatting (#9)
* Fix minor formatting inconsistencies in README * Fix minor typo in README * Enable language syntax highlighting in README
1 parent b957d7d commit 83a59c2

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# AWS Code Artifact Proxy
22

33
An AWS Code Artifact Proxy that allows you to point your package managers to Code Artifact without the need of managing credentials.
4+
45
## Why was this built?
56

67
Not every user who pulls code from your private codeartifact repository needs AWS credentials:
@@ -15,7 +16,7 @@ Although I haven't been able to test them all, the proxy should support the foll
1516
| Repository Type | Tested | URL |
1617
| --------------- | ------ | ------------------------------------- |
1718
| Pypi | Yes | https://artifacts.example.com/simple/ |
18-
| NPM | Yes | https://artifacts.example.com/ |
19+
| NPM | Yes | https://artifacts.example.com/ |
1920
| Maven | No | https://artifacts.example.com/ |
2021
| Nuget | No | https://artifacts.example.com/ |
2122

@@ -31,15 +32,15 @@ You can run this in three easy ways.
3132

3233
Configuration is done via Environment Variables:
3334

34-
| Environment Variable | Required? | Description |
35-
| -------------------- | ---------- | ----------------------- |
36-
| CODEARTIFACT_REPO | Yes | Your CodeArtifact Repository Name (e.g. sandbox) |
37-
| CODEARTIFACT_DOMAIN | Yes | Your CodeArtifact Domain (e.g. sktansandbox) |
38-
| CODEARTIFACT_TYPE | No | Use one of the following: pypi, npm, maven, nuget |
39-
| CODEARTIFACT_OWNER | No | The AWS Account Id of the CodeArtifact Owner (if it's your own account, it can be empty) |
40-
| LISTEN_PORT | No | Port on which the proxy should listen. Defaults to 8080 |
35+
| Environment Variable | Required? | Description |
36+
| -------------------- | ---------- | ----------------------- |
37+
| `CODEARTIFACT_REPO` | Yes | Your CodeArtifact Repository Name (e.g. sandbox) |
38+
| `CODEARTIFACT_DOMAIN` | Yes | Your CodeArtifact Domain (e.g. sktansandbox) |
39+
| `CODEARTIFACT_TYPE` | No | Use one of the following: pypi, npm, maven, nuget |
40+
| `CODEARTIFACT_OWNER` | No | The AWS Account ID of the CodeArtifact Owner (if it's your own account, it can be empty) |
41+
| `LISTEN_PORT` | No | Port on which the proxy should listen. Defaults to 8080 |
4142

42-
By default, the proxy will choose to use the Pypi as it's type.
43+
By default, the proxy will choose to use the Pypi as its type.
4344

4445
Once you have started the proxy with valid AWS credentials (this uses the [default credential provider chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials)), you should receive similar output to this:
4546

@@ -59,7 +60,7 @@ docker run -v /root/.aws/:/.aws -e AWS_PROFILE=sktansandbox -e CODEARTIFACT_DOMA
5960

6061
Docker Compose:
6162

62-
```
63+
```yaml
6364
version: '3.1'
6465

6566
services:
@@ -95,7 +96,7 @@ root ➜ /workspaces/aws-codeartifact-proxy/cdk (cdk ✗) $ pipenv run cdk deplo
9596
9697
If you'd rather use your own CDK codebase, you can use the following snippet in your `app.py` file:
9798
98-
```
99+
```python
99100
# Replace me with where you have placed your codeartifact module
100101
from cdk.code_artifact_proxy import CodeArtifactProxy
101102
@@ -154,7 +155,7 @@ added 2 packages in 2s
154155

155156
Use the following permissions to grant the proxy ReadOnly access to the CodeArtifact repository.
156157

157-
```
158+
```json
158159
{
159160
"Version": "2012-10-17",
160161
"Statement": [

0 commit comments

Comments
 (0)