docs: add native installation guide and REST API examples to README

[lxcxjxhx]

What Problem This Solves

The README only provided Docker-based quick setup, leaving users who need native installation or API integration without guidance.

Why This Change Was Made

Users face several challenges:

• No native installation instructions for Windows/macOS/Linux
• Missing requirements list (Python version, JDK, etc.)
• No troubleshooting for common setup issues
• REST API mentioned but no usage examples
• Users must navigate to external docs for basic setup information

Changes

• Add native installation instructions for Windows (setup.bat/run.bat) and macOS/Linux (setup.sh/run.sh)
• Include clear requirements section (Python 3.12+, Git, JDK 17+)
• Add troubleshooting section for common issues (Xcode tools, port conflicts)
• Add REST API usage section with complete curl examples
• Provide authentication and scan workflow examples
• Improve documentation structure with clear subsections

User Impact

Users can now:

• Install MobSF natively without Docker for better performance
• Understand system requirements before installation
• Resolve common setup issues independently
• Quickly integrate MobSF into CI/CD using REST API examples
• Find all essential information in the README without navigating to external docs

Evidence

• Installation commands match existing setup.bat/setup.sh scripts
• API examples follow MobSF's actual API structure
• All links verified to point to existing documentation
• No code changes, documentation only

[ajinabraham]

The README.md is not intended to serve as comprehensive documentation. Detailed project documentation, including host setup instructions and other development information, is available here: https://github.com/MobSF/docs/blob/master/develop.md

[lxcxjxhx]

Hi @ajinabraham,

Thank you for the clarification and for pointing to the official documentation repository.

I understand that README.md is not intended to serve as comprehensive documentation. The detailed project documentation is available at https://github.com/MobSF/docs.

Given this, should I:

1. Close this PR since README improvements are not the focus?
2. Simplify the PR to only fix broken links and typos in README?
3. Move the installation guide and API examples to the official docs repository instead?

I want to ensure my contribution aligns with the project's documentation strategy. Please let me know the best approach.

Thank you for your time!

[lxcxjxhx]

@ajinabraham 感谢您的反馈！您说得对，README.md确实不应该作为完整文档。

我的理解

您指出README不应包含详细的host setup和development信息，这些应该放在专门的文档仓库（MobSF/docs）。

改进方案

我可以调整PR方向：

方案1：精简README，添加文档链接

• 保留README中的快速安装步骤（3-5行）
• 添加指向 https://github.com/MobSF/docs 的明确链接
• 移除详细的配置说明和开发指南

方案2：完全移除README改动

• 如果您认为README已经足够好，我可以关闭这个PR
• 专注于改进docs仓库中的文档

方案3：只修复broken links和格式问题

• 如果README中有broken links或格式问题，我可以只修复这些问题

您倾向于哪种方案？或者您认为README应该保持现状？

我尊重您的判断，会根据您的建议调整PR方向。

感谢！