Expand description

LICENSE

@@ -1 +1,21 @@
-MIT
+MIT License
+
+Copyright (c) 2025 credshields/Solidity-CodeGen-v0.1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -12,13 +12,56 @@ tags:
 - credshields
 ---
 # Solidity-CodeGen-v0.1
-
 Solidity-CodeGen-v0.1 is a fine-tuned LLM specialized for generating Solidity smart contracts with modern OpenZeppelin patterns. It works best when paired with the OpenZeppelin Contracts MCP (Model Context Protocol) to produce canonical ERC and Governor implementations.
 
 - Base: Qwen3 (tuned for Solidity codegen)
 - Context length: Served via vLLM (up to 32k with server)
 - Recommended: Use with OpenZeppelin MCP locally for highest-quality results
 
+## Why Solidity-CodeGen-v0.1?
+
+Traditional LLMs often produce generic code that may contain security vulnerabilities or deviate from best practices. Solidity-CodeGen-v0.1 is different—it's a domain-expert model trained specifically for secure smart contract development. Instead of generating random code snippets, it creates structured, audit-grade templates using OpenZeppelin-compliant logic and predictable design patterns.
+
+Every generated contract follows OZ v5 conventions, ensuring:
+- **Canonical ERC implementations** (ERC20, ERC721, ERC1155)
+- **Consistent inheritance patterns**
+- **Reproducible function behavior**
+- **Built-in security considerations**
+
+## Security-First Architecture
+
+The model's training incorporates real-world vulnerability data from CredShields' research, including insights from [SolidityScan's Web3HackHub](https://solidityscan.com/web3hackhub)—a comprehensive database tracking blockchain security incidents since 2011. This vulnerability-aware training means the model has learned from actual exploits and financial losses, including:
+
+- **$1.42 billion** lost across 149 documented incidents in 2024 alone
+  
+- **[OWASP Smart Contract Top 10](https://scs.owasp.org/sctop10/)**: Vulnerability patterns and Common attack vectors like reentrancy, access control flaws, oracle manipulation, and more
+
+The OWASP Smart Contract Security Project plays a critical role in shaping secure development practices across the Web3 ecosystem. It serves as a foundational framework that educates developers on the most prevalent and high-impact vulnerabilities affecting smart contracts.
+By aligning with the OWASP Smart Contract Top-10, the Solidity-CodeGen model internalizes these security priorities and reinforces them through code generation. This ensures that every scaffold it produces not only adheres to OpenZeppelin standards but also reflects industry-accepted security hygiene.
+
+
+By learning from these failures, Solidity-CodeGen-v0.1 proactively avoids anti-patterns that lead to costly vulnerabilities.
+
+## Complete Security Workflow
+
+While Solidity-CodeGen-v0.1 generates secure code foundations, comprehensive security requires additional validation. **SolidityScan** provides the perfect complement—an AI-powered smart contract scanner that identifies vulnerabilities and security risks in your code.
+
+**Together, they create a complete security pipeline:**
+1. **Generate** secure contract templates with Solidity-CodeGen-v0.1
+2. **Scan** for vulnerabilities with SolidityScan's advanced analysis
+3. **Deploy** with confidence, knowing your contracts meet industry standards
+
+[Explore SolidityScan](https://solidityscan.com) to discover how AI-powered scanning can enhance your smart contract security workflow.
+
+
+<p align="center">
+  <img src="https://cdn-uploads.huggingface.co/production/uploads/685934bed73d6881647be295/CL6wjrU6gKYv3_Itc4iAO.png" alt="Solidity-CodeGen-v0.1 Banner" width="75%">
+</p>
+
+
+---
+
+
 ## How to Load
 Transformers:
 ```