Skip to content

Commit 671909c

Browse files
Merge pull request #69 from jcchavezs/tweaks_readme
docs: adds some tweaks to the readme.
2 parents 5cf5d87 + b2c7bf9 commit 671909c

2 files changed

Lines changed: 13 additions & 8 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ target/
1010
.idea/
1111
package-lock.json
1212
*/.DS_Store
13-
.DS_Store
13+
.DS_Store
14+
.settings

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Build Status](https://travis-ci.org/ExpediaDotCom/haystack-agent.svg?branch=master)](https://travis-ci.org/ExpediaDotCom/haystack-agent)
22
[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://github.com/ExpediaDotCom/haystack/blob/master/LICENSE)
3+
[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/r/com.expedia.www/haystack-agent.svg?server=https%3A%2F%2Foss.sonatype.org)](https://oss.sonatype.org/content/repositories/snapshots/com/expedia/www/haystack-agent/)
34

45
# haystack-agent
56
This repo contains haystack-agent, which can be run as a side-car container or a standalone agent on the host on which
@@ -139,7 +140,7 @@ and dispatches to the configured sink. See below for list of supported dispatche
139140
Agent's http server supports following endpoints for publishing zipkin spans:
140141

141142
```
142-
a: /api/v1/spans - accepts v1 spans(json, thrift)
143+
a. /api/v1/spans - accepts v1 spans(json, thrift)
143144
b. /api/v2/spans - accepts v2 spans(json, proto)
144145
```
145146

@@ -193,8 +194,8 @@ configuration properties for it to work properly:
193194
3. OutstandingRecordsLimit - maximum pending records that are still not published to kinesis. If agent receives more
194195
dispatch requests, then it sends back 'RATE_LIMIT_ERROR' in the GRPC response.
195196
4. AWS keys - Optional, use them if you want to connect using static AWS access and secret keys
196-
* AwsAccessKey
197-
* AwsSecretKey
197+
- AwsAccessKey
198+
- AwsSecretKey
198199
5. StsRoleArn - Optional, use it if you want to provide credentials by assuming a role
199200

200201
You can also provide AWS_ACCESS_KEY and AWS_SECRET_KEY as java system property values, or environment variable,
@@ -250,13 +251,16 @@ disable.chunked.encoding - Optional, can be either true or false
250251

251252
#### Clone
252253
Since this repo contains haystack-idl as the submodule, so use the following to clone the repo
253-
* git clone --recursive git@github.com:ExpediaDotCom/haystack-agent.git .
254+
255+
```
256+
git clone --recursive git@github.com:ExpediaDotCom/haystack-agent.git .
257+
```
254258

255259
#### Prerequisites:
256260

257-
* Make sure you have Java 1.8
258-
* Make sure you have maven 3.3.9 or higher
259-
* Make sure you have docker 1.13 or higher
261+
- Make sure you have Java 1.8
262+
- Make sure you have maven 3.3.9 or higher
263+
- Make sure you have docker 1.13 or higher
260264

261265
Note : For Mac users you can download docker for Mac to set you up for the last two steps.
262266

0 commit comments

Comments
 (0)