#major Update README.md (flyteorg#130)

Signed-off-by: Haytham Abuelfutuh <[email protected]>
honnix · Apr 22, 2022 · 30be01c · 30be01c
1 parent e914394
commit 30be01c
Showing 1 changed file with 49 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -1,68 +1,72 @@
 Common Go Tools
 =====================
-[![Current Release](https://img.shields.io/github/release/lyft/flytestdlib.svg)](https://github.com/lyft/flytestdlib/releases/latest)
-[![Build Status](https://travis-ci.org/lyft/flytestdlib.svg?branch=master)](https://travis-ci.org/lyft/flytestdlib)
-[![GoDoc](https://godoc.org/github.com/lyft/flytestdlib?status.svg)](https://godoc.org/github.com/lyft/flytestdlib)
+[![Current Release](https://img.shields.io/github/release/flyteorg/flytestdlib.svg)](https://github.com/flyteorg/flytestdlib/releases/latest)
+[![Build Status](https://github.com/flyteorg/flytestdlib/workflows/Master/badge.svg?branch=master)](https://github.com/flyteorg/flytestdlib/workflows/Master/badge.svg?branch=master)
+[![GoDoc](https://godoc.org/github.com/flyteorg/flytestdlib?status.svg)](https://godoc.org/github.com/flyteorg/flytestdlib)
 [![License](https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
-[![CodeCoverage](https://img.shields.io/codecov/c/github/lyft/flytestdlib.svg)](https://codecov.io/gh/lyft/flytestdlib)
-[![Go Report Card](https://goreportcard.com/badge/github.com/lyft/flytestdlib)](https://goreportcard.com/report/github.com/lyft/flytestdlib)
-![Commit activity](https://img.shields.io/github/commit-activity/w/lyft/flytestdlib.svg?style=plastic)
-![Commit since last releast](https://img.shields.io/github/commits-since/lyft/flytestdlib/latest.svg?style=plastic)
+[![CodeCoverage](https://img.shields.io/codecov/c/github/flyteorg/flytestdlib.svg)](https://codecov.io/gh/flyteorg/flytestdlib)
+[![Go Report Card](https://goreportcard.com/badge/github.com/flyteorg/flytestdlib)](https://goreportcard.com/report/github.com/flyteorg/flytestdlib)
+![Commit activity](https://img.shields.io/github/commit-activity/w/flyteorg/flytestdlib.svg?style=plastic)
+![Commit since last releast](https://img.shields.io/github/commits-since/flyteorg/flytestdlib/latest.svg?style=plastic)
 [![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
 
 Shared components we found ourselves building time and time again, so we collected them in one place!
 
 This library consists of:
- - config
 
-   Enables strongly typed config throughout your application. Offers a way to represent config in go structs. takes care of parsing, validating and watching for changes on config.
+- config
 
- - cli/pflags
+  Enables strongly typed config throughout your application. Offers a way to represent config in go structs. takes care
+  of parsing, validating and watching for changes on config.
 
-   Tool to generate a pflags for all fields in a given struct.
+- cli/pflags
 
-   #### Install
+  Tool to generate a pflags for all fields in a given struct.
 
-   On POSIX systems, run: `curl -sfL https://raw.githubusercontent.com/lyft/flytestdlib/godownloader/godownloader.sh | sh`
+  #### Install
 
-   On Windows:
+  On POSIX systems,
+  run: `curl -sfL https://raw.githubusercontent.com/flyteorg/flytestdlib/godownloader/godownloader.sh | sh`
 
-   Install scoop: `iex (new-object net.webclient).downloadstring('https://get.scoop.sh')`
+  On Windows:
 
-   Run: `scoop bucket add flytestdlib https://github.com/lyft/flytestdlib.git`
+  Install scoop: `iex (new-object net.webclient).downloadstring('https://get.scoop.sh')`
 
-   Run: `scoop install pflags`
+  Run: `scoop bucket add flytestdlib https://github.com/flyteorg/flytestdlib.git`
 
- - storage
+  Run: `scoop install pflags`
 
-   Abstract storage library that uses stow behind the scenes to connect to s3/azure/gcs but also offers configurable factory, in-memory storage (for testing) as well as native protobuf support.
+- storage
 
- - contextutils
+  Abstract storage library that uses stow behind the scenes to connect to s3/azure/gcs but also offers configurable
+  factory, in-memory storage (for testing) as well as native protobuf support.
 
-   Wrapper around golang's context to set/get known keys.
+- contextutils
 
- - logger
+  Wrapper around golang's context to set/get known keys.
 
-   Wrapper around logrus that's configurable, taggable and context-aware.
+- logger
 
- - profutils
+  Wrapper around logrus that's configurable, taggable and context-aware.
 
-   Starts an http server that serves /metrics (exposes prometheus metrics), /healthcheck and /version endpoints.
+- profutils
 
- - promutils
+  Starts an http server that serves /metrics (exposes prometheus metrics), /healthcheck and /version endpoints.
 
-   Exposes a Scope instance that's a more convenient way to construct prometheus metrics and scope them per component.
+- promutils
 
- - atomic
+  Exposes a Scope instance that's a more convenient way to construct prometheus metrics and scope them per component.
 
-   Wrapper around sync.atomic library to offer AtomicInt32 and other convenient types.
+- atomic
 
- - sets
+  Wrapper around sync.atomic library to offer AtomicInt32 and other convenient types.
 
-   Offers strongly types and convenient interface sets.
+- sets
 
- - utils
- - version
+  Offers strongly types and convenient interface sets.
+
+- utils
+- version
 
 Contributing
 ------------
@@ -73,31 +77,34 @@ This repo follows [semantic versioning](https://semver.org/).
 
 ## Releases
 
-This repository is hooked up with [goreleaser](https://goreleaser.com/). Maintainers are expected to create tags and let goreleaser compose the release message and create a release.
+This repository is hooked up with [goreleaser](https://goreleaser.com/). Maintainers are expected to create tags and let
+goreleaser compose the release message and create a release.
 
 To create a new release, follow these steps:
 
 - Create a PR with your changes.
 
 - [Optional] Create an alpha tag on your branch and push that.
 
-  - First get existing tags `git describe --abbrev=0 --tags`
+    - First get existing tags `git describe --abbrev=0 --tags`
 
-  - Figure out the next alpha version (e.g. if tag is v1.2.3 then you should create a v1.2.4-alpha.0 tag)
+    - Figure out the next alpha version (e.g. if tag is v1.2.3 then you should create a v1.2.4-alpha.0 tag)
 
-  - Create a tag `git tag v1.2.4-alpha.0`
+    - Create a tag `git tag v1.2.4-alpha.0`
 
-  - Push tag `git push --tags`
+    - Push tag `git push --tags`
 
 - Merge your changes and checkout master branch `git checkout master && git pull`
 
 - Bump version tag and push to branch.
 
-  - First get existing tags `git describe --abbrev=0 --tags`
+    - First get existing tags `git describe --abbrev=0 --tags`
 
-  - Figure out the next release version (e.g. if tag is v1.2.3 then you should create a v1.2.4 tag or v1.3.0 or a v2.0.0 depending on what has changed. Refer to [Semantic Versioning](https://semver.org/) for information about when to bump each)
+    - Figure out the next release version (e.g. if tag is v1.2.3 then you should create a v1.2.4 tag or v1.3.0 or a
+      v2.0.0 depending on what has changed. Refer to [Semantic Versioning](https://semver.org/) for information about
+      when to bump each)
 
-  - Create a tag `git tag v1.2.4`
+    - Create a tag `git tag v1.2.4`
 
-  - Push tag `git push --tags`
+    - Push tag `git push --tags`