Skip to content

Commit

Permalink
docs: autoupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Sep 1, 2024
1 parent 8896ee2 commit 9ade776
Showing 1 changed file with 18 additions and 60 deletions.
78 changes: 18 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,41 +15,41 @@
-->

<h1 align="center">AtomicGo | template</h1>
<h1 align="center">AtomicGo | event</h1>

<p align="center">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fatomicgo.dev%2Fapi%2Fshields%2Ftemplate&style=flat-square" alt="Downloads">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fatomicgo.dev%2Fapi%2Fshields%2Fevent&style=flat-square" alt="Downloads">

<a href="https://github.com/atomicgo/template/releases">
<img src="https://img.shields.io/github/v/release/atomicgo/template?style=flat-square" alt="Latest Release">
<a href="https://github.com/atomicgo/event/releases">
<img src="https://img.shields.io/github/v/release/atomicgo/event?style=flat-square" alt="Latest Release">
</a>

<a href="https://codecov.io/gh/atomicgo/template" target="_blank">
<img src="https://img.shields.io/github/actions/workflow/status/atomicgo/template/go.yml?style=flat-square" alt="Tests">
<a href="https://codecov.io/gh/atomicgo/event" target="_blank">
<img src="https://img.shields.io/github/actions/workflow/status/atomicgo/event/go.yml?style=flat-square" alt="Tests">
</a>

<a href="https://codecov.io/gh/atomicgo/template" target="_blank">
<img src="https://img.shields.io/codecov/c/gh/atomicgo/template?color=magenta&logo=codecov&style=flat-square" alt="Coverage">
<a href="https://codecov.io/gh/atomicgo/event" target="_blank">
<img src="https://img.shields.io/codecov/c/gh/atomicgo/event?color=magenta&logo=codecov&style=flat-square" alt="Coverage">
</a>

<a href="https://codecov.io/gh/atomicgo/template">
<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-3-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
<a href="https://codecov.io/gh/atomicgo/event">
<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-1-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
</a>

<a href="https://opensource.org/licenses/MIT" target="_blank">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square" alt="License: MIT">
</a>

<a href="https://goreportcard.com/report/github.com/atomicgo/template" target="_blank">
<img src="https://goreportcard.com/badge/github.com/atomicgo/template?style=flat-square" alt="Go report">
<a href="https://goreportcard.com/report/github.com/atomicgo/event" target="_blank">
<img src="https://goreportcard.com/badge/github.com/atomicgo/event?style=flat-square" alt="Go report">
</a>

</p>

---

<p align="center">
<strong><a href="https://pkg.go.dev/atomicgo.dev/template#section-documentation" target="_blank">Documentation</a></strong>
<strong><a href="https://pkg.go.dev/atomicgo.dev/event#section-documentation" target="_blank">Documentation</a></strong>
|
<strong><a href="https://github.com/atomicgo/atomicgo/blob/main/CONTRIBUTING.md" target="_blank">Contributing</a></strong>
|
Expand All @@ -68,7 +68,7 @@
</tbody>
</table>
</p>
<h3 align="center"><pre>go get atomicgo.dev/template</pre></h3>
<h3 align="center"><pre>go get atomicgo.dev/event</pre></h3>
<p align="center">
<table>
<tbody>
Expand All @@ -80,17 +80,13 @@

<!-- Code generated by gomarkdoc. DO NOT EDIT -->

# template
# event

```go
import "atomicgo.dev/template"
import "atomicgo.dev/event"
```

Package template is used to generate new AtomicGo repositories.

Write the description of the module here. You can use \*\*markdown\*\*\! This description should clearly explain what the package does.

Example description: https://golang.org/src/encoding/gob/doc.go
Package event provides a generic event system for Go.



Expand All @@ -101,12 +97,10 @@ package main

import (
"fmt"

"atomicgo.dev/template"
)

func main() {
fmt.Println(template.HelloWorld())
fmt.Println("Hello, World!")
}
```

Expand All @@ -120,42 +114,6 @@ Hello, World!

## Index

- [func HelloWorld\(\) string](<#HelloWorld>)


<a name="HelloWorld"></a>
## func [HelloWorld](<https://github.com/atomicgo/event/blob/main/template.go#L4>)

```go
func HelloWorld() string
```

HelloWorld returns \`Hello, World\!\`.





```go
package main

import (
"fmt"

"atomicgo.dev/template"
)

func main() {
fmt.Println(template.HelloWorld())
}
```

#### Output

```
Hello, World!
```



Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
Expand Down

0 comments on commit 9ade776

Please sign in to comment.