From 927df4d76ea0b9e47593c925283f238621d16be0 Mon Sep 17 00:00:00 2001
From: Rachel Hu <goldpiggy@berkeley.edu>
Date: Thu, 4 Apr 2024 20:59:21 -0700
Subject: [PATCH] polish readme

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index e69de29..80d0b99 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,34 @@
+# 🌊 OpenParse
+
+OpenParse provides an API to accurately extract your unstructured data (e.g. PDF, images, charts) into structured format.
+
+## :seedling: Set up your OpenParser API key
+
+OpenParse is still in private beta. If you are interested in testing our document models, please reach out at info@cambioml.com for a FREE API key.
+
+
+To set up your API key `CAMBIO_API_KEY`, you will need to :
+
+1. create a `.env` file in your root folder;
+2. add the following one line to your `.env file:
+    ```
+    CAMBIO_API_KEY=17b************************
+    ```
+
+## :computer: Installation
+
+```
+conda create -n openparse python=3.10 -y
+conda activate openparse
+pip3 install open_parser
+```
+
+## :scroll:  Examples
+
+OpenParse can extract text, numbers and symbols from PDF, images, etc. Check out each notebook below to run OpenParse within 10 lines of code!
+
+### [Prompt to Extract Key-values into JSON from W2 (PDF)](https://github.com/CambioML/open-parser/blob/main/examples/prompt_to_extract_table_from_pdf_to_json.ipynb)
+Do you want to extract key-values from a W2 PDF into JSON format? Check out this notebook (3-min read)!
+
+### [Extract a Table from an Image into Markdown Format](https://github.com/CambioML/open-parser/blob/main/examples/extract_table_from_image_to_markdown.ipynb)
+Are you a financial analyst who need to extract ACCURATE number from a table in an image or a PDF. Check out this notebook (3-min read)!
\ No newline at end of file