Skip to content

Commit

Permalink
chore: Update README with Anaya documentation link
Browse files Browse the repository at this point in the history
  • Loading branch information
swax10 committed Jul 4, 2024
1 parent 44e5aa9 commit 2a014d2
Showing 1 changed file with 3 additions and 39 deletions.
42 changes: 3 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,5 @@
# Website
# [Anaya 📑](https://swax10.github.io/anaya/docs/)

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
Anaya is a Content Engine that specializes in analyzing and comparing multiple PDF documents. It uses Retrieval Augmented Generation (RAG) techniques to effectively retrieve, assess, and generate insights from the documents. 📊🔍

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
You can access the documentation for Anaya [here](https://swax10.github.io/anaya/docs/). 📄🔗

0 comments on commit 2a014d2

Please sign in to comment.