fixed readme issues, added badges

theevenstarspace · Nov 26, 2024 · 0bd5a25 · 0bd5a25
1 parent 238b76a
commit 0bd5a25
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # Byteform
 
+![GitHub branch check runs](https://img.shields.io/github/check-runs/theevenstarspace/byteform/main?style=flat)
+![npm package minimized gzipped size (scoped)](https://img.shields.io/bundlejs/size/%40evenstar/byteform?style=flat)
+![NPM Version](https://img.shields.io/npm/v/%40evenstar%2Fbyteform?style=flat)
+
 **Byteform** is a lightweight and versatile TypeScript library designed for encoding and decoding binary data. It provides an intuitive API to work with binary structures, making it an excellent choice for developers dealing with low-level data operations in both browser and Node.js environments.
 
 ## Table of contents
@@ -50,8 +54,8 @@ const vec3 = new Struct({
 });
 
 const bullet = new Struct({
-  position: Vec3,
-  velocity: Vec3,
+  position: vec3,
+  velocity: vec3,
   damage: u8
 });
 

diff --git a/docs/docs/README.md b/docs/docs/README.md
@@ -1,5 +1,9 @@
 # Byteform
 
+![GitHub branch check runs](https://img.shields.io/github/check-runs/theevenstarspace/byteform/main?style=flat)
+![npm package minimized gzipped size (scoped)](https://img.shields.io/bundlejs/size/%40evenstar/byteform?style=flat)
+![NPM Version](https://img.shields.io/npm/v/%40evenstar%2Fbyteform?style=flat)
+
 **Byteform** is a lightweight and versatile TypeScript library designed for encoding and decoding binary data. It provides an intuitive API to work with binary structures, making it an excellent choice for developers dealing with low-level data operations in both browser and Node.js environments.
 
 ## Table of contents
@@ -50,8 +54,8 @@ const vec3 = new Struct({
 });
 
 const bullet = new Struct({
-  position: Vec3,
-  velocity: Vec3,
+  position: vec3,
+  velocity: vec3,
   damage: u8
 });
 

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
   "bugs": {
     "url": "https://github.com/theevenstarspace/byteform/issues"
   },
-  "homepage": "https://github.com/theevenstarspace/byteform",
+  "homepage": "https://byteform.js.org",
   "packageManager": "[email protected]",
   "devDependencies": {
     "@eslint/js": "^9.15.0",