This repository has been archived by the owner on Oct 9, 2023. It is now read-only.
forked from micro/micro
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.go
121 lines (85 loc) · 1.49 KB
/
readme.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
package template
var (
Readme = `# {{title .Alias}} Service
This is the {{title .Alias}} service
Generated with
` + "```" +
`
{{.Command}}
` + "```" + `
## Getting Started
- [Configuration](#configuration)
- [Dependencies](#dependencies)
- [Usage](#usage)
## Configuration
- FQDN: {{.FQDN}}
- Type: {{.Type}}
- Alias: {{.Alias}}
## Dependencies
Micro services depend on service discovery. The default is consul.
` + "```" +
`
# install consul
brew install consul
# run consul
consul agent -dev
` + "```" + `
## Usage
A Makefile is included for convenience
Build the binary
` + "```" +
`
make build
` + "```" + `
Run the service
` + "```" +
`
./{{.Alias}}-{{.Type}}
` + "```" + `
Build a docker image
` + "```" +
`
make docker
` + "```"
ReadmeFNC = `# {{title .Alias}} Function
This is the {{title .Alias}} function
Generated with
` + "```" +
`
{{.Command}}
` + "```" + `
## Getting Started
- [Configuration](#configuration)
- [Dependencies](#dependencies)
- [Usage](#usage)
## Configuration
- FQDN: {{.FQDN}}
- Type: {{.Type}}
- Alias: {{.Alias}}
## Dependencies
Micro functions depend on service discovery. The default is consul.
` + "```" +
`
# install consul
brew install consul
# run consul
consul agent -dev
` + "```" + `
## Usage
A Makefile is included for convenience
Build the binary
` + "```" +
`
make build
` + "```" + `
Run the function once
` + "```" +
`
./{{.Alias}}-{{.Type}}
` + "```" + `
Build a docker image
` + "```" +
`
make docker
` + "```"
)