Commit 32cfa2f1c4445d58a81be37df6d514ac0e485bad

Parents: f5c5444ee8cddb12613563d29645210531ce7f95

From: Moritz Poldrack <git@moritz.sh>
Date: Mon Dec 6 18:12:31 2021 +0700

updated import path
added contribution guidelines

Stats

CONTRIBUTING.md +39/-0
LICENSE +1/-1
README.md +12/-0
demo/main.go +1/-1
go.mod +1/-1

Changeset

  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
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000000000000000000000000000000000..469c7cc7da6728756986079976126b3dabf2c914
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# Contributing Guidelines
+
+## Before Contributing
+
+Hi, there! Thanks for your interest in Contributing to this Project. Please
+make sure that you read these Guidelines thoroughly before sending your
+changeset or it may be rejected. If you feel like there is an issue in these
+guidelines, please send an email detailing your issue to
+[~poldi1405/issues@todo.sr.ht](mailto:~poldi1405/issues@todo.sr.ht), prefixing
+the subject with [meta].
+
+## General Guidelines
+
+- Please enure that in your Commit you sign off the [Developer Certificate of
+  Origin](https://developercertificate.org/)
+- Feedback will be provided via the channel of submission.
+- Please format your code using the
+  [gofumpt](https://github.com/mvdan/gofumpt)-tool
+
+### git send-email
+
+This is the preferred method and will usually lead to a faster approval.
+
+A Step-by-Step Guide for beginners can be found at
+[git-send-email.io](https://git-send-email.io/)
+
+Please configure git to add the project name as a prefix to the subject by
+following this example: `git config format.subjectPrefix 'PATCH go-ansi'` for
+go-ansi.
+
+Send your patches to [~poldi1405/patches@lists.sr.ht](https://lists.sr.ht/~poldi1405/patches)
+
+### GitHub-Pull Request
+
+- Create a copy of this Repo on your Account using the "Fork" Button at the top
+- Make your changes
+- Press the "Create Pull Request"-Button
+- you may send an email containing a link to your Pull Request to the
+  mailinglist at [~poldi1405/patches@lists.sr.ht](https://lists.sr.ht/~poldi1405/patches)
diff --git a/LICENSE b/LICENSE
index 085eae4e26248b3ba94ec7f069892e1d14dfd562..4941a402ec29ad2324f7f404a2d2cb4ce6a91af6 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Moritz Poldrack
+Copyright (c) 2020-2021 Moritz Poldrack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index acc2c1429fb4260466d92208804e0180e7efd55e..0badaddaa23aa8bcef764599a08ef0e6eaaffd4a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,12 @@
 # go-ansi
 
+![Version](https://img.shields.io/badge/dynamic/json?color=green&label=Version&query=%24.latest_version&url=https%3A%2F%2Fmpldr.codes%2Fansi%2Fapi%2Fversions%2Flatest&style=flat-square&logo=git&color=F05032)
+![License: MIT](https://img.shields.io/static/v1?color=green&label=License&message=MIT&style=flat-square&logo=open-source-initiative&color=3DA639)
+
+```
+import "mpldr.codes/ansi"
+```
+
 Write pretty terminal output the easy way.
 
 Want your text green? `ansi.Green("I am Shrek")`
@@ -25,3 +32,8 @@ [`NO_COLOR`](https://no-color.org/) standard.   This  disables  all
 colour-related   ANSI-Codes  but  does  not restrict  any other
 function (like  cursor  movement  or  formatting).  If this behavior
 is unwanted please stay on version 1.3.0 or below.
+
+## License
+
+This library is licensed under the MIT License which can be found
+[here](https://git.sr.ht/~poldi1405/go-ansi/tree/master/item/LICENSE).
diff --git a/demo/main.go b/demo/main.go
index 9e660c0f68ccdda952f5b0e40a20b50f46146129..6ab118b60510e45e5df3dcf8c3574d503d49d726 100644
--- a/demo/main.go
+++ b/demo/main.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"time"
 
-	"git.sr.ht/~poldi1405/go-ansi"
+	"mpldr.codes/ansi"
 )
 
 func main() {
diff --git a/go.mod b/go.mod
index d06bdeab8b86f5e4a3f2a0f072a6170dc3365fd2..63ac4e4f2e9b3a27724510a7d85f4ee375cef3eb 100644
--- a/go.mod
+++ b/go.mod
@@ -1,3 +1,3 @@
-module git.sr.ht/~poldi1405/go-ansi
+module mpldr.codes/ansi
 
 go 1.15