Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheCompez committed Dec 18, 2024
1 parent 4e08a04 commit b42bb34
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,34 +49,34 @@ cd XCLI
### Basic Command Structure

```bash
twitter_cli <command> [options]
xcli <command> [options]
```

### Available Commands

- **`auth`**: Authenticate with Twitter using OAuth 2.0.
```bash
twitter_cli auth
xcli auth
```

- **`get`**: Perform a GET request to a specified API endpoint.
```bash
twitter_cli get <endpoint> [key=value ...]
xcli get <endpoint> [key=value ...]
```

Example:
```bash
twitter_cli get /2/users/by/username/johndoe user.fields=id,name,username
xcli get /2/users/by/username/johndoe user.fields=id,name,username
```

- **`space`**: Fetch information about a Twitter Space using its Space ID.
```bash
twitter_cli space <space_id>
xcli space <space_id>
```

Example:
```bash
twitter_cli space 1vOGwMNOZXYxB
xcli space 1vOGwMNOZXYxB
```

### Example Output
Expand All @@ -101,19 +101,18 @@ API Response:

```
XCLI/
├── source/ # Source code files
│ ├── XCLI.cpp # Main implementation of XCLI
├── source/ # Source code files & Header files
│ └── xcli.hpp # Declaration of XCLI class
│ ├── xcli.cpp # Main implementation of XCLI
│ └── ...
├── include/ # Header files
│ └── XCLI.hpp # Declaration of XCLI class
├── third-party/ # Third-party dependencies (e.g., JSON library)
├── CMakeLists.txt # CMake configuration
└── README.md # Project documentation
```

## Configuration

Modify the following constants in `XCLI.hpp` as needed:
Modify the following constants in `xcli.hpp` as needed:

- `tokenFile`: Path to the JSON file where authentication tokens are stored.

Expand Down

0 comments on commit b42bb34

Please sign in to comment.