Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sandys authored Sep 20, 2023
1 parent c7f0caa commit 1f5dac5
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,18 @@
---
## Installation and Usage Quickstart

**Edgechains works on Java & Android right now. Javascript is upcoming**
**Edgechains works on Java. Javascript is upcoming**

To set up EdgeChains, you will need to download the release jar (`edgechain.jar`) from [https://github.com/arakoodev/EdgeChains/releases](https://github.com/arakoodev/EdgeChains/releases)

Once downloaded, Follow these steps:

1. **Copy all the contents from the _Examples_ folder** and paste into your folder. The _Examples_ folder includes all the Jsonnet files and `EdgeChainApplication.java` file.
2. **Prepare your OpenAI Key:** EdgeChains requires a valid OpenAI key to interact with the language models. Make sure you have your OpenAI Auth Key available, as you will need to add it in `EdgeChainApplication.java` file (there will be placeholders for `OPENAI_AUTH_KEY` and `OPENAI_ORG_ID` )
3. **Configure Redis/Supabase/Pincone Connection:** locate the redisenv method in the Redisenv class in `EdgeChainApplication.java` file. Add your URL, port, and password to the appropriate fields in the method.

Once you have completed these configuration steps, you are ready to run EdgeChains.

To start the application, execute the following command in your terminal:
Running an EdgeChains Generative AI application is exceedingly simple and 2 steps.

```bash
# Go inside any of the examples
# Step 1 - download edgechain.jar from [releases](https://github.com/arakoodev/EdgeChains/releases)
wget

# Step 2 - Go inside any of the examples and run a java command
java -jar edgechain.jar jbang Hello.java

# NOTE - please set the appropriate OpenAI, Supabase, Pinecone, etc keys inside the Hello.java file.
```
### [Stuck?? Try the Docs](https://www.arakoo.ai/doc/category/getting-started)

Expand Down

0 comments on commit 1f5dac5

Please sign in to comment.