Skip to content

Commit

Permalink
Improve Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Rizal Widyarta Gowandy committed Aug 29, 2021
1 parent ed2d013 commit b493660
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 13 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2021, BenaluCorp
Copyright (c) 2021, Rizal Widyarta Gowandy
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[![Go Doc](https://pkg.go.dev/badge/github.com/benalucorp/library-template-go?status.svg)](https://pkg.go.dev/github.com/benalucorp/library-template-go?tab=doc)
[![Release](https://img.shields.io/github/release/benalucorp/library-template-go.svg?style=flat-square)](https://github.com/benalucorp/library-template-go/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/benalucorp/library-template-go)](https://goreportcard.com/report/github.com/benalucorp/library-template-go)
[![Build Status](https://github.com/benalucorp/library-template-go/workflows/Go/badge.svg?branch=main)](https://github.com/benalucorp/library-template-go/actions?query=branch%3Amain)
[![Sourcegraph](https://sourcegraph.com/github.com/benalucorp/library-template-go/-/badge.svg)](https://sourcegraph.com/github.com/benalucorp/library-template-go?badge)
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/benalucorp/library-template-go)](https://www.tickgit.com/browse?repo=github.com/benalucorp/library-template-go)
[![Go Doc](https://pkg.go.dev/badge/github.com/rizalgowandy/library-template-go?status.svg)](https://pkg.go.dev/github.com/rizalgowandy/library-template-go?tab=doc)
[![Release](https://img.shields.io/github/release/rizalgowandy/library-template-go.svg?style=flat-square)](https://github.com/rizalgowandy/library-template-go/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/rizalgowandy/library-template-go)](https://goreportcard.com/report/github.com/rizalgowandy/library-template-go)
[![Build Status](https://github.com/rizalgowandy/library-template-go/workflows/Go/badge.svg?branch=main)](https://github.com/rizalgowandy/library-template-go/actions?query=branch%3Amain)
[![Sourcegraph](https://sourcegraph.com/github.com/rizalgowandy/library-template-go/-/badge.svg)](https://sourcegraph.com/github.com/rizalgowandy/library-template-go?badge)

![gdk](https://socialify.git.ci/benalucorp/library-template-go/image?description=1&language=1&owner=1&pattern=Floating%20Cogs&theme=Light)
![gdk](https://socialify.git.ci/rizalgowandy/library-template-go/image?description=1&language=1&pattern=Floating%20Cogs&theme=Light)

## Getting Started

Expand All @@ -15,7 +14,7 @@

```shell
# TODO: replace me
go get -v github.com/benalucorp/library-template-go
go get -v github.com/rizalgowandy/library-template-go
```

## Quick Start
Expand Down
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ representative at an online or offline event. Representation of a project may be

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at `[email protected]`. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [Rizal Widyarta Gowandy](https://twitter.com/rizalgow). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated
to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TODO: replace me
module github.com/benalucorp/library-template-go
module github.com/rizalgowandy/library-template-go

go 1.16

Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
package library

import (
"github.com/benalucorp/library-template-go/pkg/api"
"github.com/rizalgowandy/library-template-go/pkg/api"
)

// TODO: replace me
Expand Down
2 changes: 1 addition & 1 deletion main_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"os"
"testing"

"github.com/benalucorp/library-template-go/pkg/api"
"github.com/rizalgowandy/library-template-go/pkg/api"
"github.com/kokizzu/gotro/L"
)

Expand Down

0 comments on commit b493660

Please sign in to comment.