-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(alloy): update README with decsriptive information and example
- Loading branch information
1 parent
339d3a9
commit 7360a0a
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
## 🔎 Overview | ||
*alloy* is a **Go module that enables calls to Rust code with Apache Arrow datatypes**, and vice versa. | ||
|
||
The overarching goal is to enable calls between languages through an underlying **C** interface, utilizing **cgo** and **Rust ffi**. | ||
This implementation comes with close to no overhead due to using the Apache Arrow data format. The only thing sent between the language binaries are raw data pointers referencing the allocated memory (in Arrow format). This allows for | ||
fast, (somewhat) robust, and colorful use cases in data engineering scenarios. | ||
|
||
Alloy means a mixture between two or more components and is (currently) a joint vernture between Rickard Ernst Björn Lundin (Go) and Wilhelm Ågren (Rust). If this project invokes interest in you, the reader, *feel free to contribute in any way or form*. | ||
|
||
## 📦 Installation | ||
... | ||
|
||
## 🚀 Example usage | ||
|
||
The example file [main.go](./main.go) should envision how your Go application could utilize *alloy* to call Rust code. | ||
|
||
<details> | ||
<summary>Show example code</summary> | ||
|
||
```go | ||
package main | ||
|
||
... | ||
|
||
``` | ||
|
||
</details> | ||
|
||
## 📋 License | ||
All code is to be held under a general MIT license, please see [LICENSE](https://github.com/ignalina/alloy/blob/main/LICENSE) for specific information. |