apache · Xuanwo · Oct 18, 2023 · Oct 18, 2023 · Oct 18, 2023
@@ -0,0 +1,41 @@
+# OpenDAL Bindings
+
+This folder contains the bindings for OpenDAL. Currently, we support the following bindings:
+
+### Released Bindings
+
+* [Java](java/README.md)
+* [Node.js](nodejs/README.md)
+* [Python](python/README.md)
+
+### Unreleased Bindings
+
+* [C](c/README.md)
+* [C++](cpp/README.md)
+* [C#](dotnet/README.md)
+* [Go](go/README.md)
+* [Haskell](haskell/README.md)
+* [Lua](lua/README.md)
+* [OCaml](ocaml/README.md)
+* [PHP](php/README.md)
+* [Ruby](ruby/README.md)
+* [Swift](swift/README.md)
+* [Zig](zig/README.md)
+
+## Getting Started
+
+Every binding should provide a `README.md` file to help users get started.
+The `README.md` file should contain the following sections:
+
+* **Installation**: how to install the binding.
+* **Usage**: how to use the binding.
+* **Development**: how to develop the binding.
+* **Testing**: how to test the binding.
+
+You can find the `README.md` file for each binding in the corresponding folder.
+
+Please refer to the bindings listed above or which are already released for more details.
+
+## Contributing
+
+We welcome contributions to OpenDAL. Please refer to [CONTRIBUTING.md](../../CONTRIBUTING.md) for the contributing guidelines.
@@ -1,5 +1,7 @@
 # OpenDAL C Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 ## Example

@@ -1,5 +1,7 @@
 # OpenDAL CPP Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 Documents: [![Documents](https://img.shields.io/badge/opendal-cpp-blue?logo=Apache&logoColor=red)](https://opendal.apache.org/docs/cpp/)
@@ -99,4 +101,4 @@ make docs
 - `OPENDAL_ENABLE_ADDRESS_SANITIZER`: Enable address sanitizer. Default: `OFF`
 - `OPENDAL_ENABLE_DOCUMENTATION`: Enable documentation. Default: `OFF`
 - `OPENDAL_DOCS_ONLY`: Only build documentation. Default: `OFF`
-- `OPENDAL_ENABLE_TESTING`: Enable testing. Default: `OFF`
+- `OPENDAL_ENABLE_TESTING`: Enable testing. Default: `OFF`
@@ -0,0 +1,5 @@
+# OpenDAL .Net Binding (WIP)
+
+![](https://img.shields.io/badge/status-unreleased-red)
+
+This binding is currently under development. Please check back later.
@@ -1,5 +1,7 @@
 # OpenDAL Go Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 opendal-go requires opendal-c to be installed.
 
 ```shell

@@ -1,5 +1,7 @@
 # OpenDAL Haskell Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 ## Example
@@ -52,4 +54,4 @@ To generate the documentation:
 cabal haddock
 ```
 
-If your `cabal` version is greater than `3.8`, you can use `cabal haddock --open` to open the documentation in your browser. Otherwise, you can visit the documentation from `dist-newstyle/build/$ARCH/ghc-$VERSION/opendal-$VERSION/doc/html/opendal/index.html`.
+If your `cabal` version is greater than `3.8`, you can use `cabal haddock --open` to open the documentation in your browser. Otherwise, you can visit the documentation from `dist-newstyle/build/$ARCH/ghc-$VERSION/opendal-$VERSION/doc/html/opendal/index.html`.
@@ -1,5 +1,6 @@
 # OpenDAL Java Bindings
 
+![](https://img.shields.io/badge/status-released-blue)
 [![Maven Central](https://img.shields.io/maven-central/v/org.apache.opendal/opendal-java.svg?logo=Apache+Maven&logoColor=blue)](https://central.sonatype.com/search?q=opendal-java&smo=true)
 [![Website](https://img.shields.io/badge/opendal-OpenDAL_Website-red?logo=Apache&logoColor=red)](https://opendal.apache.org/docs/java/)
 

@@ -1,5 +1,7 @@
 # OpenDAL Lua Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 ## Example

@@ -1,5 +1,9 @@
 # OpenDAL Node.js Binding
 
+![](https://img.shields.io/badge/status-released-blue)
+[![npm](https://img.shields.io/npm/v/opendal.svg?logo=npm)](https://www.npmjs.com/package/opendal)
+[![Website](https://img.shields.io/badge/opendal-OpenDAL_Website-red?logo=Apache&logoColor=red)](https://opendal.apache.org/docs/nodejs/)
+
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 ## Installation

@@ -1,5 +1,7 @@
 # OpenDAL OCaml Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 ## Requirements
 
 * OCaml version > 4.03 and < 5.0.0
@@ -74,4 +76,4 @@ To execute unit tests, we can simply use the following command:
 ```bash
 cd bindings/ocaml
 dune test
-```
+```
@@ -1,4 +1,6 @@
-# OpenDAL PHP Binding
+# OpenDAL PHP Binding (WIP)
+
+![](https://img.shields.io/badge/status-unreleased-red)
 
 ## Example
 

@@ -1,5 +1,9 @@
 # OpenDAL Python Binding
 
+![](https://img.shields.io/badge/status-released-blue)
+[![PyPI](https://img.shields.io/pypi/v/opendal.svg?logo=PyPI)](https://pypi.org/project/opendal/)
+[![Website](https://img.shields.io/badge/opendal-OpenDAL_Website-red?logo=Apache&logoColor=red)](https://opendal.apache.org/docs/python/)
+
 Documentation: [main](https://opendal.apache.org/docs/python/)
 
 This crate intends to build a native python binding.

@@ -1,4 +1,6 @@
-# OpenDAL Ruby Binding
+# OpenDAL Ruby Binding (WIP)
+
+![](https://img.shields.io/badge/status-unreleased-red)
 
 This crate intends to build a native ruby binding.
 

@@ -1,4 +1,6 @@
-# OpenDAL Swift Binding
+# OpenDAL Swift Binding (WIP)
+
+![](https://img.shields.io/badge/status-unreleased-red)
 
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 

@@ -1,5 +1,7 @@
 # OpenDAL Zig Binding (WIP)
 
+![](https://img.shields.io/badge/status-unreleased-red)
+
 ![](https://github.com/apache/incubator-opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 ## Build