docs(readme): move more example to docs/doc.md #3449
Merged
+2,321
−2,277
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@appleboy please review, thanks!
Motivation:
moving
API examples
to docs/doc.md, reduce length ofREADME
and use weight of page for reading example code.Result:
![image](https://user-images.githubusercontent.com/4488261/209456764-f222cff0-bace-497c-8895-ac54babf49fb.png)
![image](https://user-images.githubusercontent.com/4488261/209456784-ca0cd925-4c50-432c-baba-3579548e9741.png)
before:
after: