Skip to content

Commit 192bbf2

Browse files
kouraulcd
andauthored
chore: Add basic README (#62)
## What's Changed This is based on https://github.com/apache/arrow-js/blob/main/README.md . Closes #23. --------- Co-authored-by: Raúl Cumplido <[email protected]>
1 parent 77f0890 commit 192bbf2

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Apache Arrow Swift
21+
22+
[Apache Arrow](https://arrow.apache.org/) is a universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics. It contains a set of technologies that enable data systems to efficiently store, process, and move data.
23+
24+
## Install
25+
26+
TODO: We should update this after we register this package to Swift Package Index.
27+
28+
## Getting Started
29+
30+
TODO: We should refer auto generated documentation on Swift Package Index after we register this package to Swift Package Index.
31+
32+
## Getting involved
33+
34+
Even if you do not plan to contribute to Apache Arrow itself or Apache Arrow integrations in other projects, we'd be happy to have you involved:
35+
36+
* [Join the mailing list](https://arrow.apache.org/community/#mailing-lists): Share your ideas and use cases for the project
37+
* Follow our activity on [GitHub Issues](https://github.com/apache/arrow-swift/issues)
38+
* Contribute code
39+
40+
We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [github.com/apache/arrow-swift](https://github.com/apache/arrow-swift) repository.
41+
42+
If you are looking for some ideas on what to contribute, check out the [GitHub
43+
Issues](https://github.com/apache/arrow-swift/issues) for the Apache Arrow Swift project. Comment on the issue, [GitHub Discussions](https://github.com/apache/arrow-swift/discussions) and/or contact [[email protected]](https://arrow.apache.org/community/#mailing-lists) with your questions and ideas.
44+
45+
If you'd like to report a bug but don't have time to fix it, you can still post it on GitHub issues.
46+
47+
## License
48+
49+
[Apache 2.0](https://github.com/apache/arrow-swift/blob/main/LICENSE.txt)

0 commit comments

Comments
 (0)