Skip to content

Commit

Permalink
Update readme and website
Browse files Browse the repository at this point in the history
  • Loading branch information
tsterbak committed Jun 18, 2024
1 parent adf7e7f commit e4bea25
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,12 @@ pip install promptmage
To use promptmage, run the following command:

```bash
promptmage <path-to-flow>
promptmage run <path-to-flow>
```

Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application.
This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000`.

## Roadmap

Coming soon.
Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application or workflow.


## Development
Expand Down
15 changes: 8 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@
The approach with "PromptMage" is to provide a pragmatic solution that bridges the current gap in LLM workflow management. We aim to empower developers, researchers, and organizations by making LLM technology more accessible and manageable, thereby supporting the next wave of AI innovations.

## Philosophy
- Prompts as first-class citizens
- Integrate the prompt playground into your workflow for fast iteration
- Prompts as first-class citizens with version control and collaboration features
- Manual and automatic testing and validation of prompts
- Easy sharing of results with domain experts and stakeholders
- build-in, automatically created API with fastAPI for easy integration and deployment
- Type-hint everything for automatic inference and validation magic
- build-in, automatically created API with fastAPI for easy integration

## Getting Started

Expand All @@ -37,14 +40,12 @@ pip install promptmage
To use promptmage, run the following command:

```bash
promptmage <path-to-flow>
promptmage run <path-to-flow>
```

Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application.
This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000`.

## Roadmap

Coming soon.
Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application or workflow.


## Development
Expand Down

0 comments on commit e4bea25

Please sign in to comment.