From c669736a4ff15352f02f49fd6534431a283e2d11 Mon Sep 17 00:00:00 2001
From: Adam Binford <adamq43@gmail.com>
Date: Mon, 11 Sep 2023 18:39:15 -0400
Subject: [PATCH] Add Python readme

---
 python/README.md      | 16 ++++++++++++++++
 python/pyproject.toml |  2 ++
 2 files changed, 18 insertions(+)
 create mode 100644 python/README.md

diff --git a/python/README.md b/python/README.md
new file mode 100644
index 0000000..528018e
--- /dev/null
+++ b/python/README.md
@@ -0,0 +1,16 @@
+Native HDFS Python bindings based on hdfs-native Rust package.
+
+## Installation
+
+```bash
+pip install hdfs-native
+```
+
+## Example
+
+```python
+from hdfs_native import Client
+client = Client("hdfs://localhost:9000")
+
+status = client.get_file_info("/file.txt")
+```
\ No newline at end of file
diff --git a/python/pyproject.toml b/python/pyproject.toml
index e27eaf0..42fd84d 100644
--- a/python/pyproject.toml
+++ b/python/pyproject.toml
@@ -4,6 +4,8 @@ build-backend = "maturin"
 
 [project]
 name = "hdfs_native"
+description = "Python bindings for hdfs-native Rust library"
+readme = "README.md"
 requires-python = ">=3.7"
 classifiers = [
     "Programming Language :: Rust",