Skip to content

Commit fc1d59b

Browse files
committed
housekeeping and documentation
1 parent 0684f66 commit fc1d59b

5 files changed

Lines changed: 54 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
![tm](https://raw.githubusercontent.com/txn2/tm/master/mast.jpg)
2+
[![tm Release](https://img.shields.io/github/release/txn2/tm.svg)](https://github.com/txn2/tm/releases)
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/txn2/tm)](https://goreportcard.com/report/github.com/txn2/tm)
4+
[![GoDoc](https://godoc.org/github.com/txn2/tm?status.svg)](https://godoc.org/github.com/txn2/tm)
5+
[![Docker Container Image Size](https://shields.beevelop.com/docker/image/image-size/txn2/tm/latest.svg)](https://hub.docker.com/r/txn2/tm/)
6+
[![Docker Container Layers](https://shields.beevelop.com/docker/image/layers/txn2/tm/latest.svg)](https://hub.docker.com/r/txn2/tm/)
27

3-
WIP: TXN2 types model API
8+
9+
TXN2 types model API
410

511
## Configuration
612

‎cmd/tm.go‎

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,25 @@
1-
/*
2-
Copyright 2019 txn2
3-
Licensed under the Apache License, Version 2.0 (the "License");
4-
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at
6-
http://www.apache.org/licenses/LICENSE-2.0
7-
Unless required by applicable law or agreed to in writing, software
8-
distributed under the License is distributed on an "AS IS" BASIS,
9-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10-
See the License for the specific language governing permissions and
11-
limitations under the License.
12-
*/
1+
// Copyright 2019 txn2
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
// http://www.apache.org/licenses/LICENSE-2.0
6+
// Unless required by applicable law or agreed to in writing, software
7+
// distributed under the License is distributed on an "AS IS" BASIS,
8+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
// See the License for the specific language governing permissions and
10+
// limitations under the License.
11+
1312
package main
1413

1514
import (
1615
"flag"
1716
"os"
1817

19-
"go.uber.org/zap"
20-
2118
"github.com/gin-gonic/gin"
22-
2319
"github.com/txn2/micro"
2420
"github.com/txn2/provision"
2521
"github.com/txn2/tm"
22+
"go.uber.org/zap"
2623
)
2724

2825
var (

‎model.go‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
// Copyright 2019 txn2
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
// http://www.apache.org/licenses/LICENSE-2.0
6+
// Unless required by applicable law or agreed to in writing, software
7+
// distributed under the License is distributed on an "AS IS" BASIS,
8+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
// See the License for the specific language governing permissions and
10+
// limitations under the License.
11+
112
package tm
213

314
import "github.com/txn2/es"
@@ -6,7 +17,7 @@ const IdxModel = "models"
617

718
// Model
819
type Model struct {
9-
// a lowercase under score delimited uniq id
20+
// MachineName is a lowercase under score delimited uniq id
1021
MachineName string `json:"machine_name" mapstructure:"machine_name"`
1122

1223
// short human readable display name

‎search.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
// Copyright 2019 txn2
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
// http://www.apache.org/licenses/LICENSE-2.0
6+
// Unless required by applicable law or agreed to in writing, software
7+
// distributed under the License is distributed on an "AS IS" BASIS,
8+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
// See the License for the specific language governing permissions and
10+
// limitations under the License.
11+
112
package tm
213

314
import (

‎tm.go‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
/*
2-
Copyright 2019 txn2
3-
Licensed under the Apache License, Version 2.0 (the "License");
4-
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at
6-
http://www.apache.org/licenses/LICENSE-2.0
7-
Unless required by applicable law or agreed to in writing, software
8-
distributed under the License is distributed on an "AS IS" BASIS,
9-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10-
See the License for the specific language governing permissions and
11-
limitations under the License.
12-
*/
1+
// Copyright 2019 txn2
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
// http://www.apache.org/licenses/LICENSE-2.0
6+
// Unless required by applicable law or agreed to in writing, software
7+
// distributed under the License is distributed on an "AS IS" BASIS,
8+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
// See the License for the specific language governing permissions and
10+
// limitations under the License.
11+
12+
// Package tm implements Type Models for txn2 projects.
1313
package tm
1414

1515
import (

0 commit comments

Comments
 (0)
⌂ 换网址