Commit 84cfcdee5491e1772a3400007d6e58477b5bee92

Parents: 6db2a890f26cf3133be1fed40c946ed5964a8ef3

From: Moritz Poldrack <git@moritz.sh>
Date: Thu Apr 7 15:46:46 2022 +0700

updated README

		

Stats

README.md +32/-8

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
diff --git a/README.md b/README.md
index 0badaddaa23aa8bcef764599a08ef0e6eaaffd4a..ac1071f8a3a14fb2b62a59196959eb84b2bd5187 100644
--- a/README.md
+++ b/README.md
@@ -14,24 +14,48 @@
 Want it black on a red ground? `ansi.RedBG(ansi.Black("You can just
 combine them"))`
 
-Moving around is as simple as Specifying direction `ansi.Up()`
+Moving around is as simple as Specifying a direction `ansi.Up()`
 
-## ANSI Support
+## ANSI Support¹
 
 - movement
 - line operations (clearing lines)
 - fore- and background colour
 - formatting (bold, italic, strikethrough, )
 - stripping ANSI-Codes
-- hyperlinks (WIP)
+- links (even to files)
+- notifications
+
+¹) support depends on the terminal emulator used and configuration
 
 ## User Choice
 
-This  library  implements   the  (informal)
-[`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.
+This library implements the (informal) [`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.
+
+## Bugs Reports & Feature Requests
+
+Bug Reports and Feature Requests can be sent to the [issue
+tracker](https://todo.sr.ht/~poldi1405/issues?title=[go-ansi]%20) or via email
+to [~poldi1405/issues@todo.sr.ht](mailto:~poldi1405/issues@todo.sr.ht?subject=[go-ansi]%20)
+(possible without creating an account on Sourcehut).
+
+### Patches
+
+Want to improve it yourself? Awesome! Please send your patches to
+[~poldi1405/patches@lists.sr.ht](mailto:~poldi1405/patches@lists.sr.ht) (see
+submitted patches [here](https://lists.sr.ht/~poldi1405/patches)).
+
+For an easy quickstart, just run these commands:
+
+```shell
+$ git config format.subjectPrefix "PATCH go-ansi"
+$ git config sendemail.to "~poldi1405/patches@lists.sr.ht"
+```
+
+Please sign-off your Commits to confirm the [DCO](https://developercertificate.org/).
 
 ## License