@socketsecurity/sdk 3.0.27 → 3.0.28

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [3.0.28](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.0.28) - 2025-11-01
+
+### Changed
+
+- Updated `@socketsecurity/lib` to v3.0.3
+
 ## [3.0.27](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.0.27) - 2025-10-31
 
 ### Changed

package/README.md

@@ -8,6 +8,27 @@
 
 JavaScript SDK for [Socket.dev](https://socket.dev/) API - Security analysis, vulnerability scanning, and compliance monitoring for software supply chains.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Methods](#api-methods) - [Full API Reference](./docs/api-reference.md)
+- [Documentation](#documentation)
+- [Examples](#examples)
+
+## At a Glance
+
+| Feature | Description |
+|---------|-------------|
+| **Package Analysis** | Quick security checks for npm packages |
+| **Full Scans** | Deep analysis with SBOM support |
+| **Batch Operations** | Analyze multiple packages efficiently |
+| **Policy Management** | Configure security & license rules |
+| **Quota Utilities** | Cost calculation & planning helpers |
+| **TypeScript** | Full type safety with auto-generated types |
+
+**Requirements:** Node.js 18+ • ESM only (v2.0+)
+
 ## Installation
 
 ```bash
@@ -142,19 +163,33 @@ Raw API access: `getApi()` • `sendApi()`
 
 [→ Documentation](./docs/api-reference.md#advanced-query-methods)
 
-**[→ API Reference](./docs/api-reference.md)**
-
-**[→ Examples](./docs/usage-examples.md)**
-
-**[→ Quota Management](./docs/quota-management.md)** - Cost tiers: 0 (free), 10 (standard), 100 (batch/uploads)
-
-**[→ Testing Utilities](./docs/dev/testing.md)** - Mock factories, fixtures, type guards
-
-## See Also
-
-- [Socket.dev API Reference](https://docs.socket.dev/reference) - Official API documentation
-- [Socket CLI](https://github.com/SocketDev/socket-cli) - Command-line interface
-- [Socket GitHub App](https://github.com/apps/socket-security) - GitHub integration
+## Documentation
+
+| Guide | Description |
+|-------|-------------|
+| **[API Reference](./docs/api-reference.md)** | Complete API method documentation |
+| **[Usage Examples](./docs/usage-examples.md)** | Real-world patterns and code samples |
+| **[Getting Started](./docs/getting-started.md)** | Development setup and workflow |
+| **[Quota Management](./docs/quota-management.md)** | Cost tiers (0/10/100) and utilities |
+| **[Testing Guide](./docs/dev/testing.md)** | Test helpers, fixtures, and patterns |
+| **[Method Reference](./docs/when-to-use-what.md)** | Quick method selection guide |
+
+## Examples
+
+See **[usage-examples.md](./docs/usage-examples.md)** for complete examples including:
+- Package security analysis
+- Batch operations
+- Full scans with SBOM
+- Policy management
+- Quota planning
+
+## Related Projects
+
+| Project | Description |
+|---------|-------------|
+| [Socket.dev API](https://docs.socket.dev/reference) | Official REST API documentation |
+| [Socket CLI](https://github.com/SocketDev/socket-cli) | Command-line interface |
+| [Socket GitHub App](https://github.com/apps/socket-security) | Automated GitHub integration |
 
 ## License