docs: readme updates

[shikhar]

No description provided.

[greptile-apps]

Greptile Overview

Greptile Summary

This PR improves the README documentation with better clarity and organization:

• Clarified that s2-lite is embedded as a CLI subcommand rather than just "available"
• Added mention of --local-root option for local disk persistence alongside in-memory mode
• Reorganized sections to improve flow: moved configuration NOTE after examples for better context
• Changed S2_ACCESS_TOKEN value from "redundant" to "ignored" for accuracy
• Converted "Caveats" section into a TIP callout with clearer messaging about pipelining
• Improved API specs formatting with better list structure
• Converted API coverage from bullet lists to a clean table format

Confidence Score: 5/5

• This PR is completely safe to merge with zero risk
• Documentation-only changes that improve clarity and organization without any code modifications or breaking changes
• No files require special attention

Important Files Changed

Filename	Overview
README.md	Documentation improvements: clarified wording, reorganized sections, improved formatting with table, updated token value to "ignored"

Sequence Diagram

sequenceDiagram
    participant Author
    participant README as README.md
    participant Reader as Documentation Reader
    
    Author->>README: Clarify s2-lite is "embedded" in CLI
    Author->>README: Add local disk option (--local-root)
    Author->>README: Add TIP callout for integration tests
    Author->>README: Move configuration NOTE after examples
    Author->>README: Update S2_ACCESS_TOKEN from "redundant" to "ignored"
    Author->>README: Convert "Caveats" section to TIP callout
    Author->>README: Reorganize API specs formatting
    Author->>README: Convert API coverage to table format
    
    Reader->>README: Read improved documentation
    README-->>Reader: Clearer structure and information

Loading