add godocs docu

This commit is contained in:
6543 2020-09-21 06:54:44 +02:00
parent a9b81cfa0c
commit 7398be3efb
Signed by: 6543
GPG Key ID: A1CA74D27FD13271
3 changed files with 41 additions and 0 deletions

33
doc.go Normal file
View File

@ -0,0 +1,33 @@
// Copyright 2020 6543. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

/*

Package hexcolor is a simple hexcolor normalizer

Installation

go get -u github.com/6543/go-hexcolor

Example

```go
package main

import (
"fmt"
"github.com/6543/go-hexcolor"
)

func main() {
c, err := hexcolor.NewHexColor("#adf")
if err != nil {
panic(err)
}
fmt.Println(c.ToString())
}
```

*/
package hexcolor

View File

@ -1,3 +1,7 @@
// Copyright 2020 6543. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package hexcolor

import (

View File

@ -1,3 +1,7 @@
// Copyright 2020 6543. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package hexcolor

import (