This repository has been archived by the owner on Apr 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from sandrask/issue-5
docs: Update readme
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,35 @@ | ||
[![Release](https://img.shields.io/github/release/trustbloc/edge-core.svg?style=flat-square)](https://github.com/trustbloc/edge-core/releases/latest) | ||
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/trustbloc/edge-core/master/LICENSE) | ||
[![Godocs](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/trustbloc/edge-core) | ||
|
||
[![Build Status](https://dev.azure.com/trustbloc/edge/_apis/build/status/trustbloc.edge-core?branchName=master)](https://dev.azure.com/trustbloc/edge/_build/latest?definitionId=36&branchName=master) | ||
[![codecov](https://codecov.io/gh/trustbloc/edge-core/branch/master/graph/badge.svg)](https://codecov.io/gh/trustbloc/edge-core) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/trustbloc/edge-core)](https://goreportcard.com/report/github.com/trustbloc/edge-core) | ||
|
||
# edge-core | ||
|
||
Edge Core implements core components that are shared between various edge services. | ||
|
||
## Prerequisites (General) | ||
- Go 1.13 | ||
|
||
## Targets | ||
``` | ||
# run checks and unit tests | ||
make all | ||
# run linter checks | ||
make lint | ||
# run license checks | ||
make license | ||
# run unit tests | ||
make unit-test | ||
``` | ||
|
||
## Contributing | ||
Thank you for your interest in contributing. Please see our [community contribution guidelines](https://github.com/trustbloc/community/blob/master/CONTRIBUTING.md) for more information. | ||
|
||
## License | ||
Apache License, Version 2.0 (Apache-2.0). See the [LICENSE](LICENSE) file. |