doc: update readme.md [skip ci]

l2studio · Jun 5, 2021 · 3bbd1af · 3bbd1af
1 parent 7e3a599
commit 3bbd1af
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,24 @@
 # L2 Studio - Minecraft Ping
 
+<p>
+<a href="https://github.com/l2studio/minecraft-ping/actions"><img src="https://img.shields.io/github/workflow/status/l2studio/minecraft-ping/CI?logo=github&style=flat-square"/></a>
+<a href="https://www.npmjs.com/package/@l2studio/minecraft-ping"><img src="https://img.shields.io/npm/v/@l2studio/minecraft-ping?logo=npm&style=flat-square"/></a>
+</p>
+
 A library for Minecraft server ping
 
 ## Install
 
+```shell
+npm install --save @l2studio/minecraft-ping
+# or
+pnpm i @l2studio/minecraft-ping
+```
+
 ## API
 
+TODO
+
 ## License
 
 Apache-2.0