From 2f3d50b19d5f988a682d86364e016d4f58a396a0 Mon Sep 17 00:00:00 2001
From: Sean Lee <xmlee97@gmail.com>
Date: Tue, 21 May 2024 17:16:57 +0800
Subject: [PATCH] add document URL

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 3232c94..db34d37 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@
 
 > It is Angle 📐, not Angel 👼.
 
+📘 document: https://angle.readthedocs.io/en/latest/index.html
+
 <a href="https://arxiv.org/abs/2309.12871">
     <img src="https://img.shields.io/badge/Arxiv-2309.12871-yellow.svg?style=flat-square" alt="https://arxiv.org/abs/2309.12871" />
 </a>
@@ -13,6 +15,11 @@
 <a href="https://pypi.org/project/angle_emb/">
     <img src="https://img.shields.io/pypi/dm/angle_emb?style=flat-square" alt="PyPI Downloads" />
 </a>
+<a href="https://angle.readthedocs.io/en/latest/index.html">
+    <img src="https://readthedocs.org/projects/angle/badge/?version=latest&style=flat-square
+    " alt="Read the docs" />
+</a>
+
 
 [![PWC](https://img.shields.io/endpoint.svg?url=https://paperswithcode.com/badge/angle-optimized-text-embeddings/semantic-textual-similarity-on-sick-r-1)](https://paperswithcode.com/sota/semantic-textual-similarity-on-sick-r-1?p=angle-optimized-text-embeddings)
 [![PWC](https://img.shields.io/endpoint.svg?url=https://paperswithcode.com/badge/angle-optimized-text-embeddings/semantic-textual-similarity-on-sts16)](https://paperswithcode.com/sota/semantic-textual-similarity-on-sts16?p=angle-optimized-text-embeddings)