From 8eaf4439e23c3d854a514ceeb675f84ffb3c4001 Mon Sep 17 00:00:00 2001
From: rwxe <jzunk@protonmail.com>
Date: Thu, 28 Sep 2023 22:46:47 +0800
Subject: [PATCH] Add a special README before the PR is merged by the upstream

---
 README.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9c9c9b1..bfbae93 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,24 @@
-[![Build Status](https://travis-ci.org/JohnCGriffin/overflow.png)](https://travis-ci.org/JohnCGriffin/overflow)
 # overflow
 Check for integer overflow in Golang arithmetic and type conversion.
 ### Install
+
+*This is a special README before the PR is merged by the upstream.*
+
+This repository forks from `johncgriffin/overflow` and adds overflow detection for unsigned
+integer arithmetic and type conversions between integers.
+It has been well tested and benchmarked, and passed the code security scan provided by
+Github Workflow.
+
+[![CodeQL](https://github.com/rwxe/overflow/actions/workflows/codeql.yml/badge.svg?branch=master)](https://github.com/rwxe/overflow/actions/workflows/codeql.yml) [![DevSkim](https://github.com/rwxe/overflow/actions/workflows/devskim.yml/badge.svg?branch=master)](https://github.com/rwxe/overflow/actions/workflows/devskim.yml) [![Codacy Security Scan](https://github.com/rwxe/overflow/actions/workflows/codacy.yml/badge.svg?branch=master)](https://github.com/rwxe/overflow/actions/workflows/codacy.yml) 
+
+
 ```sh
-go get github.com/johncgriffin/overflow
+go get github.com/rwxe/overflow
 ```
-Note that because Go has no template types, the majority of repetitive code is 
-generated by overflow_template.sh.  If you have to change an
-algorithm, change it there and regenerate the Go code via:
+In order to be compatible with old code, and when this project was created, there were no
+generics in Go, so the majority of repetitive code is generated by `overflow_template.sh`. 
+If you have to change an algorithm, change it there and regenerate the Go code via: 
+
 ```sh
 go generate
 ```
@@ -19,7 +30,7 @@ package main
 
 import "fmt"
 import "math"
-import "github.com/JohnCGriffin/overflow"
+import "github.com/rwxe/overflow"
 
 func main() {