added license, README partial badges

Author: Rajat Arya

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, XetData
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

README.md

@@ -2,46 +2,48 @@
    <img src="https://github.com/xetdata/pyxet/blob/0c7608c97f6a2a0cb2c83dd38fb717913c4d7522/docs/images/logo.png" alt="logo" width="400" />
 </p>
 
-# Welcome to pyxet's documentation!
+
+# pyxet - The SDK for XetHub
+
+[![Version](https://img.shields.io/pypi/v/pyxet.svg?style=flat)](https://pypi.python.org/pypi/pyxet/)
+[![Python](https://img.shields.io/pypi/pyversions/pyxet.svg?style=flat)](https://pypi.python.org/pypi/pyxet/)
+[![License](https://img.shields.io/pypi/l/pyxet.svg?style=flat)](https://github.com/xetdata/pyxet/blob/main/LICENSE)
+[![Downloads](https://img.shields.io/pypi/dm/pyxet?style=flat)](https://pypi.python.org/pypi/pyxet/)
+[![Discord](https://img.shields.io/discord/1100889165777862807)](https://discord.gg/KCzmjDaDdC)
 
 pyxet is a Python library that provides a lightweight interface for the [XetHub](https://xethub.com/) platform.   
 XetHub is a blob-store with a filesystem like interface and git capabilities, therefore pyxet implement both.
 
 ## Features
 
-1. A filesystem interface.
+1. A filesystem interface:
     * [fsspec](https://filesystem-spec.readthedocs.io)
         * copy
         * remove
         * list
         * etc.
     * [glob](https://docs.python.org/3/library/glob.html)
     * [pathlib.Path](https://docs.python.org/3/library/pathlib.html)(WIP)
-2. Mount.
+
+2. Mount:
     * Read-only optimize for speed; perfect for data exploration and analysis and building data-apps and model
       inference.
-    * Read-write for data ingestion and preparation; optimal for database backups and training and monitoring logs.
-3. Git capabilities:
-    * add, commit, push
-    * clone, fork
-    * merge, rebase
-    * pull, fetch
-    * checkout, reset
-    * stash, diff, log
-    * status, branch
-    * submodules
-      ...
-4. Integrations:
+    * Read-write for data ingestion and preparation; optimal for database backups and training and monitoring logs. _(coming soon)_
+
+3. Integrations:
     - [x] [GitHub](https://github.com) [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
     - [x] [pandas](https://pandas.pydata.org)
     - [x] [polars](https://pola-rs.github.io/polars-book/)
     - [x] [pyarrow](https://arrow.apache.org/docs/python/)
     - [ ] [duckdb](https://duckdb.org/)
     - [ ] [dask](https://dask.org/)
     - [ ] [ray](https://ray.io/)
-5. CLI: All the features are available through the CLI too under `xet <command>`.
 
-For API documentation and full examples, please see the [documentation](TODO).
+For API documentation and full examples, please see the [documentation](https://pyxet.readthedocs.io/en/latest/).
+
+## Getting Started
+
+
 
 ## Installation
 
@@ -219,4 +221,4 @@ lazy_df = pl.scan_parquet(ds.dataset("file.parquet",
 
 # Project examples
 
-* [Titanic-app](https://xethub.com/xdssio/titanic-server-example)
+* [Titanic-app](https://xethub.com/xdssio/titanic-server-example)