thomas/droidclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README: fix paths for flat structure, add docs links

Browse Source 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Sanju Sivalingam
2026-02-06 16:11:51 +05:30
parent 73f967a467
commit cd348b7c34
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -112,7 +112,6 @@ You'll need to enable **USB Debugging** on your phone:
### 3. Install dependencies and configure ### 3. Install dependencies and configure
```bash ```bash
cd android-action-kernel
bun install bun install
cp .env.example .env cp .env.example .env
``` ```
@@ -572,7 +571,7 @@ If you set `STREAMING_ENABLED=false`, every provider falls back to the standard
Seven source files, no subdirectories, no frameworks beyond the LLM SDKs: Seven source files, no subdirectories, no frameworks beyond the LLM SDKs:
``` ```
android-action-kernel/src/ src/
kernel.ts Main agent loop — ties everything together kernel.ts Main agent loop — ties everything together
actions.ts 15 action implementations + device detection + ADB retry logic actions.ts 15 action implementations + device detection + ADB retry logic
llm-providers.ts LLM abstraction (4 providers) + system prompt + message types llm-providers.ts LLM abstraction (4 providers) + system prompt + message types
@@ -580,6 +579,11 @@ android-action-kernel/src/
config.ts Reads .env into a typed Config object config.ts Reads .env into a typed Config object
constants.ts ADB keycodes, coordinate ratios, defaults, magic values constants.ts ADB keycodes, coordinate ratios, defaults, magic values
logger.ts Session logging with crash-safe partial writes logger.ts Session logging with crash-safe partial writes
docs/
adb-commands.md Full ADB shell commands reference (750+ commands)
capabilities-and-limitations.md What the kernel can and cannot do
use-cases.md 50+ detailed use cases across 15 categories
``` ```
### Data flow in one step ### Data flow in one step
@@ -693,6 +697,12 @@ A few things to try:
**Cloud device farms (BrowserStack, Firebase Test Lab)** — Those are designed for automated testing at scale. This is designed for single-device autonomous task completion. You could potentially use this kernel with a cloud device, but that's not the primary use case. **Cloud device farms (BrowserStack, Firebase Test Lab)** — Those are designed for automated testing at scale. This is designed for single-device autonomous task completion. You could potentially use this kernel with a cloud device, but that's not the primary use case.
## Documentation
- **[Use Cases](docs/use-cases.md)** — 50+ detailed examples across 15 categories (messaging, social media, navigation, settings, shopping, automation, and more)
- **[ADB Commands Reference](docs/adb-commands.md)** — Complete reference of 750+ ADB shell commands available through the `shell` action
- **[Capabilities & Limitations](docs/capabilities-and-limitations.md)** — What the kernel can do, what it can't, and what needs root
## License ## License
MIT MIT