Merge pull request #20 from firefliesai/chore-sc-70927-improve-readme

chore: improve README and bump to 1.0.1

Author: grimmerk

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to Schema Forge will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2025-03-25
+
+1. Improve README
+
 ## [1.0.0] - 2025-03-22
 
 ### 🎉 First Official Release
@@ -44,4 +48,4 @@ Schema Forge is now ready for production use! This release provides a complete T
 - First stable release with a complete feature set
 - Documentation with comprehensive examples
 - Full test coverage for all supported features and LLM providers
-- CI/CD pipeline for quality assurance
+- CI/CD pipeline for quality assurance

README.md

@@ -1,6 +1,6 @@
 # Schema Forge
 
-[![npm version](https://img.shields.io/npm/v/schema-forge.svg)](https://www.npmjs.com/package/@firefliesai/schema-forge)
+[![npm version](https://img.shields.io/npm/v/@firefliesai/schema-forge.svg)](https://www.npmjs.com/package/@firefliesai/schema-forge)
 [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Schema Forge is a powerful TypeScript library that transforms your TypeScript classes into JSON Schema definitions, with special support for LLM (Large Language Model) function calling formats including OpenAI, Anthropic Claude, and Google Gemini. It also provides direct converters to transform your existing JSON Schemas into LLM-compatible formats without requiring TypeScript classes.
@@ -123,13 +123,10 @@ import 'reflect-metadata';
 
 // Option 1: Import individual exports (most common)
 import { ToolMeta, classToJsonSchema } from '@firefliesai/schema-forge';
-// @ToolMeta({ name: 'example' })
-// classToJsonSchema(UserClass);
 
 // Option 2: Import Schema object (alternative)
+// Schema object contains all exports (ToolMeta, ToolProp, classToJsonSchema, etc.)
 import { Schema } from '@firefliesai/schema-forge';
-// @Schema.ToolMeta({ name: 'example' })
-// Schema.classToJsonSchema(UserClass);
 ```
 
 ### TypeScript Configuration

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firefliesai/schema-forge",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",
   "exports": {