Skip to content

Commit

Permalink
readme: upload doc and readme
Browse files Browse the repository at this point in the history
Signed-off-by: Vincenzo Palazzo <[email protected]>
  • Loading branch information
vincenzopalazzo committed Dec 2, 2021
1 parent 04a0a20 commit 166a958
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ lint:

check:
$(CC) test -v ./...

doc:
$(CC) doc .
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# lnmetrics.utils
The collection of util function and wrapper interface around go libraris user in the LNOpenMetrics project
<div align="center">
<h1> lnmetrics.utils </h1>

<img src="https://github.com/OpenLNMetrics/lnmetrics.icons/blob/main/current/res/mipmap-xxxhdpi/ic_launcher.png" />

<p>
<strong> A collection of util function and wrapper interface around go libraris user in the LNOpenMetrics project</strong>
</p>

<p>
<a href="https://github.com/LNOpenMetrics/go-lnmetrics.reporter/actions">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/LNOpenMetrics/lnmetrics.utils/Build%20and%20test%20Go?style=flat-square">
</a>
<a href="https://discord.gg/vFX989za">
<img alt="Discord" src="https://img.shields.io/discord/913794833498394634?style=flat-square">
</a>
<a href="https://pkg.go.dev/github.com/LNOpenMetrics/go-lnmetrics.reporter">
<img src="https://pkg.go.dev/badge/github.com/LNOpenMetrics/go-lnmetrics.reporter.svg" alt="Go Reference"/>
</a>
</p>
</div>

## Table of Content

- Introduction
- License

### Introduction

TODO

### License

TODO

0 comments on commit 166a958

Please sign in to comment.