Skip to content

Commit c7502f7

Browse files
committed
Update README and the license
1 parent a85deb2 commit c7502f7

File tree

2 files changed

+13
-52
lines changed

2 files changed

+13
-52
lines changed

LICENSE LICENSE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The MIT License (MIT)
2-
Copyright © 2016 Iori MIZUTANI <[email protected]>
2+
Copyright © 2016-2019 Iori MIZUTANI <[email protected]>
33

44
Permission is hereby granted, free of charge, to any person obtaining a copy
55
of this software and associated documentation files (the “Software”), to deal

README.md

+12-51
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,21 @@
1-
go-llrp
2-
==========
1+
# go-llrp
32

4-
5-
[![Build Status](https://travis-ci.org/iomz/go-llrp.svg?branch=master)](https://travis-ci.org/iomz/go-llrp)
3+
[![GoDoc](https://godoc.org/github.com/iomz/go-llrp?status.svg)](http://godoc.org/github.com/iomz/go-llrp)
4+
[![Travis Build Status](https://travis-ci.org/iomz/go-llrp.svg?branch=master)](https://travis-ci.org/iomz/go-llrp)
65
[![Coverage Status](https://coveralls.io/repos/iomz/go-llrp/badge.svg?branch=master)](https://coveralls.io/github/iomz/go-llrp?branch=master)
76
[![Go Report Card](https://goreportcard.com/badge/github.com/iomz/go-llrp)](https://goreportcard.com/report/github.com/iomz/go-llrp)
8-
[![GoDoc](https://godoc.org/github.com/iomz/go-llrp?status.svg)](http://godoc.org/github.com/iomz/go-llrp)
9-
10-
Description
11-
-----------
7+
[![GitHub](https://img.shields.io/github/license/iomz/go-llrp.svg)](https://github.com/iomz/go-llrp/blob/master/LICENSE)
128

13-
Tiny llrp library for simple tag data event streaming
9+
The go-llrp package is a tiny library for simple LLRP message and paramter composition.
10+
See [golemu](https://github.com/iomz/golemu) for an example use of this package.
1411

15-
Installation
16-
------------
12+
## Installation
1713

18-
This package can be installed with the go get command:
14+
Install [dep](https://github.com/golang/dep) first and do the following:
1915

20-
go get github.com/iomz/go-llrp
16+
go get github.com/iomz/go-llrp && cd $GOPATH/src/github.com/iomz/go-llrp && dep ensure
2117

22-
Documentation
23-
-------------
24-
25-
API documentation can be found [here](http://godoc.org/github.com/iomz/go-llrp)
26-
and an example application is [here](https://github.com/iomz/gologir).
27-
Further examples are being prepared soon.
28-
29-
Benchmark
30-
---------
18+
## Benchmark
3119

3220
```bash
3321
% go test -run=XXX -bench=BenchmarkUnmarshal -timeout=0 -v -benchmem
@@ -49,33 +37,6 @@ ok github.com/iomz/go-llrp 82016.381s
4937
go test -run=XXX -bench=BenchmarkUnmarshal -timeout=0 -v -benchmem 158855.53s user 671.25s system 194% cpu 22:46:57.00 total
5038
```
5139

52-
Author
53-
------
54-
55-
Iori Mizutani (iomz)
40+
## License
5641

57-
License
58-
-------
59-
60-
```
61-
The MIT License (MIT)
62-
Copyright © 2016 Iori MIZUTANI <[email protected]>
63-
64-
Permission is hereby granted, free of charge, to any person obtaining a copy
65-
of this software and associated documentation files (the “Software”), to deal
66-
in the Software without restriction, including without limitation the rights
67-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
68-
copies of the Software, and to permit persons to whom the Software is
69-
furnished to do so, subject to the following conditions:
70-
71-
The above copyright notice and this permission notice shall be included in
72-
all copies or substantial portions of the Software.
73-
74-
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
75-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
76-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
77-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
78-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
79-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
80-
THE SOFTWARE.
81-
```
42+
Licensed under the MIT license. Copyright (c) 2016-2019 Iori Mizutani.

0 commit comments

Comments
 (0)