From 2181a740fb1a9ef9fb8ebce712d46e2f00b90756 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Kripalani?= Date: Wed, 2 Dec 2020 00:14:25 +0000 Subject: [PATCH] add godocs link to README. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 531d205..e86ab25 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ > 🐺 A library to curb OOMs by running Go GC according to a user-defined policy. +[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/raulk/go-watchdog) + go-watchdog runs a singleton memory watchdog. It takes system and heap memory readings periodically, and feeds them to a user-defined policy to determine whether GC needs to run immediately. @@ -10,7 +12,7 @@ This library ships with two policies out of the box: * watermarks policy: runs GC at configured watermarks of system or heap memory utilisation. -* adaptive: runs GC when the current usage surpasses a dynamically-set +* adaptive policy: runs GC when the current usage surpasses a dynamically-set threshold. You can easily build a custom policy tailored to the allocation patterns of your