Skip to content

Commit 3c77bf1

Browse files
committed
Improve README.md
1 parent 0ffca32 commit 3c77bf1

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ It's aim is to simplify reporting metrics to CloudWatch:
1010
- using EMF avoids additional HTTP API calls to CloudWatch as metrics are logged in JSON format to stdout
1111
- no need for additional dependencies in your services (or mocks in tests) to report metrics from inside your code
1212
- built in support for default dimensions and properties for Lambda functions
13-
- TODO support for default dimensions and properties for EC2 (please send pull requests)
1413

1514
Supports namespaces, setting dimensions and properties as well as different contexts (at least partially).
1615

17-
Usage:
16+
## Installation
17+
18+
```shell
19+
go get github.com/prozz/aws-embedded-metrics-golang
20+
```
21+
22+
## Usage
1823

1924
```
2025
emf.New().Namespace("mtg").Metric("totalWins", 1500).Log()
@@ -67,3 +72,10 @@ Functions for setting up dimensions:
6772
func Dimension(key, value string)
6873
func DimensionSet(dimensions ...Dimension) // use `func NewDimension` for creating one
6974
```
75+
76+
## Contributing
77+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
78+
Please make sure to update tests.
79+
80+
## License
81+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)