Added license and readme
This commit is contained in:
parent
7d00bc0452
commit
500e15b5e6
18
COPYING
Normal file
18
COPYING
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
Copyright © 2019 Brandon Dyck
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
34
README.md
Normal file
34
README.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
hatmill - HTML generation DSL for Go
|
||||||
|
=====================================
|
||||||
|
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://gitlab.codemonkeysoftware.net/b/hatmill/blob/master/COPYING)
|
||||||
|
[![Gitlab pipeline status](https://gitlab.codemonkeysoftware.net/b/hatmill/badges/master/pipeline.svg)](https://gitlab.codemonkeysoftware.net/b/hatmill/commits/master)
|
||||||
|
[![Go Report Card](https://goreportcard.com/badge/gitlab.codemonkeysoftware.net/b/hatmill)](https://goreportcard.com/report/gitlab.codemonkeysoftware.net/b/hatmill)
|
||||||
|
[![GoDoc](https://godoc.org/gitlab.codemonkeysoftware.net/b/hatmill?status.svg)](https://godoc.org/gitlab.codemonkeysoftware.net/b/hatmill)
|
||||||
|
![Badge count](https://img.shields.io/badge/badges-5-yellow.svg)
|
||||||
|
|
||||||
|
Installation
|
||||||
|
---------------
|
||||||
|
There are three necessary packages:
|
||||||
|
|
||||||
|
- `gitlab.codemonkeysoftware.net/b/hatmill`
|
||||||
|
- `gitlab.codemonkeysoftware.net/b/hatmill/attribute`
|
||||||
|
- `gitlab.codemonkeysoftware.net/b/hatmill/element`
|
||||||
|
|
||||||
|
Install them as you would any other Go package, with `go get` or whatever.
|
||||||
|
`gitlab.codemonkeysoftware.net/b/hatmill` is a Go module and so will play nicely
|
||||||
|
with Go ≥ 1.11.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
------
|
||||||
|
Basic types are in `gitlab.codemonkeysoftware.net/b/hatmill`. The `attribute`
|
||||||
|
and `element` subpackages contain helper functions for HTML5 attributes and
|
||||||
|
elements. See the `Example` function in `hatmill_test.go`.
|
||||||
|
|
||||||
|
Hacking
|
||||||
|
--------
|
||||||
|
If there is a missing attribute or element helper function, describe it in
|
||||||
|
`defs.json` and run `go generate` in the repository root. If you can't figure
|
||||||
|
out what you need to know by reading `defs.json`, `internal/codegen/*`,
|
||||||
|
`attribute/*`, and `element/*`, then
|
||||||
|
[pester me](https://gitlab.codemonkeysoftware.net/b/hatmill/issues/new) to
|
||||||
|
improve the documentation.
|
Loading…
Reference in New Issue
Block a user