Update README.md

README.md

@@ -1,3 +1,16 @@
+---
+license: mit
+language:
+- en
+base_model:
+- Qwen/Qwen3-4B-Instruct-2507
+tags:
+- solidity
+- smart_contract
+- web3
+- solidityscan
+- 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.
@@ -8,13 +21,14 @@ Solidity-CodeGen-v0.1 is a fine-tuned LLM specialized for generating Solidity sm
 
 ## How to Load
 Transformers:
+```
 from transformers import AutoTokenizer, AutoModelForCausalLM
 tok = AutoTokenizer.from_pretrained("credshields/Solidity-CodeGen-v0.1")
 model = AutoModelForCausalLM.from_pretrained("credshields/Solidity-CodeGen-v0.1", torch_dtype="auto", device_map="auto")
-
+```
 
 vLLM:
-vllm serve YOUR_ORG/Solidity-CodeGen-v0.1 --dtype auto --port 8005
+```vllm serve YOUR_ORG/Solidity-CodeGen-v0.1 --dtype auto --port 8005```
 
 
 ## Recommended: Use OpenZeppelin MCP (Locally)
@@ -29,11 +43,14 @@ This model card does not include MCP files; use the official OZ MCP project loca
 When MCP is unavailable, use structured prompts:
 
 - Start with:
+```
   - “Generate only Solidity code in a single ```
   - “Solidity: ^0.8.27 and OpenZeppelin v5 imports only (@openzeppelin/contracts/...).”
 - Specify contract type, features, and constraints.
+```
 
 Example (ERC20 minimal, mintable):
+```
 Generate only Solidity code in a single ```
 Solidity: ^0.8.27, OpenZeppelin v5 imports only.
 Contract: ERC20 token
@@ -44,7 +61,7 @@ Constraints:
 Imports: ERC20, Ownable
 constructor(address initialOwner) and Ownable(initialOwner)
 No burn, no pause, no permit
-
+```
 
 ## Quality and Limitations
 - With MCP: ERC20/721/1155 and Governor scaffolds are canonical; custom templates are solid but require review.
@@ -61,4 +78,4 @@ No burn, no pause, no permit
 - Generated code: user responsibility; OpenZeppelin Contracts are MIT-licensed.
 
 ## Note
-Early version—acts mainly as a custom template generator, not a full, production‑ready contract.
+Note: This preview focuses on tailored scaffolds for common patterns and may omit end‑to‑end features; treat outputs as starting points to be completed, validated, and audited.