Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README of example directory #2383

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Add README of example directory #2383

merged 5 commits into from
Dec 17, 2024

Conversation

JinHai-CN
Copy link
Contributor

What problem does this PR solve?

Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR.

Type of change

  • Documentation Update

@JinHai-CN JinHai-CN added the documentation Improvements or additions to documentation label Dec 17, 2024
example/README.md Outdated Show resolved Hide resolved
example/README.md Outdated Show resolved Hide resolved
example/README.md Outdated Show resolved Hide resolved
sudo apt install curl
```

The HTTP API only works for the server version of Infinity. Once the Infinity server is started, users can run these scripts using commands similar to the following
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The HTTP API only works for the server version of Infinity. Once the Infinity server is started, users can run these scripts using commands similar to the following
> [!CAUTION]
> The HTTP APIs work only with the Infinity server. Ensure that an Infinity server is running properly before executing these scripts:

JinHai-CN and others added 4 commits December 17, 2024 11:30
Co-authored-by: writinwaters <[email protected]>
Co-authored-by: writinwaters <[email protected]>
Co-authored-by: writinwaters <[email protected]>
Signed-off-by: Jin Hai <[email protected]>
@JinHai-CN JinHai-CN merged commit 2d92dcb into infiniflow:main Dec 17, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants