NERDDISCO commited on
Commit
69bcf09
Β·
1 Parent(s): 38029f4

docs: clean up readme

Browse files
Files changed (1) hide show
  1. README.md +8 -53
README.md CHANGED
@@ -1,63 +1,18 @@
1
- # πŸ€– lerobot.js
2
 
3
- JavaScript/TypeScript robotics library for Node.js and browsers. Control hardware directly without Python dependencies.
4
 
5
  ## Install
6
 
7
  ```bash
8
- # CLI tools
9
- npm install -g lerobot
10
-
11
- # Web library
12
  npm install @lerobot/web
13
- ```
14
-
15
- ## CLI Usage
16
-
17
- ```bash
18
- # Find hardware
19
- lerobot find-port
20
 
21
- # Calibrate device
22
- lerobot calibrate --robot.type=so100_follower --robot.port=COM4 --robot.id=my_robot
23
-
24
- # Show help
25
- lerobot --help
26
  ```
27
 
28
- ## Web Usage
29
-
30
- ```typescript
31
- import { findPort, calibrate, teleoperate } from "@lerobot/web";
32
-
33
- // Find and connect to hardware
34
- const devices = await findPort();
35
- const robot = devices[0];
36
-
37
- // Calibrate
38
- const calibration = await calibrate(robot);
39
- await calibration.result;
40
-
41
- // Control
42
- const controller = await teleoperate(robot);
43
- controller.start();
44
- ```
45
-
46
- ## Hardware Support
47
-
48
- - **SO-100**: Follower/leader robot arms
49
- - **WebSerial API**: Chrome/Edge 89+, HTTPS required
50
- - **Node.js**: Cross-platform serial port access
51
-
52
- ## Demo
53
-
54
- ```bash
55
- git clone https://github.com/timpietrusky/lerobot.js
56
- cd lerobot.js && npm install && npm run dev
57
- ```
58
-
59
- Visit `http://localhost:5173` for the web interface.
60
-
61
- ## License
62
 
63
- Apache-2.0
 
 
1
+ # LeRobot.js
2
 
3
+ > interact with your robot in JS, inspired by [LeRobot](https://github.com/huggingface/lerobot)
4
 
5
  ## Install
6
 
7
  ```bash
8
+ # Web library (available now)
 
 
 
9
  npm install @lerobot/web
 
 
 
 
 
 
 
10
 
11
+ # Node.js library (coming soon)
12
+ # npm install @lerobot/node
 
 
 
13
  ```
14
 
15
+ ## Resources
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
+ - **πŸ“– Documentation**: See [`@lerobot/web` README](./packages/web/README.md) for complete API reference
18
+ - **πŸš€ Live Demo**: Try it online at [huggingface.co/spaces/NERDDISCO/LeRobot.js](https://huggingface.co/spaces/NERDDISCO/LeRobot.js)