WasmEdge icon indicating copy to clipboard operation
WasmEdge copied to clipboard

[Rust SDK] Update `wasmedge-sys` crate descriptions and Readme

Open yanganto opened this issue 3 years ago • 3 comments

Motivation

Currently, the description of wasmedge-sys is not updated, and less helpful for users. For example, the ErrorReport is refactored, and the document is out of date. Besides, the design principles section did not help users to use wasmedge-sys crate. Provide a general using example, or make a list of examples with brief descriptions.

Details

  • https://github.com/WasmEdge/WasmEdge/blob/master/bindings/rust/wasmedge-sys/README.md
  • https://github.com/WasmEdge/WasmEdge/blob/master/bindings/rust/wasmedge-sys/README_zh.md

Appendix

None

yanganto avatar Dec 13 '21 03:12 yanganto

Please could you assign this to me?

divya-mohan0209 avatar Jun 02 '22 05:06 divya-mohan0209

Hello @yanganto , this might seem like a newbie question but what are the examples we'd exactly consider adding here?

divya-mohan0209 avatar Jul 01 '22 04:07 divya-mohan0209

Hi @divya-mohan0209,

The issue was to update the README.md and README_zh.md. You may check the crate and write a workable example to help others use this crate, and also if you want a more specific spec for README.md, please connect to @hydai.

By the way, I have noticed that README.md was already updated 17 days before, if it is good from your side and @hydai side, then I can help this issue for the README_zh.md part and close this issue.

Thanks for taking care on this :)

yanganto avatar Jul 01 '22 04:07 yanganto

This issue is no longer available, closing it.

hydai avatar Nov 04 '22 09:11 hydai