Skip to content

Commit 406995c

Browse files
docs: flesh out readme (#3)
* Adding a readme template Signed-off-by: Alex Volkov <[email protected]> * Added preview images Added images from thread * docs: cleanup ai readme * docs: final tweaks --------- Signed-off-by: Alex Volkov <[email protected]> Co-authored-by: t11s <[email protected]>
1 parent af772d9 commit 406995c

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

README.md

+36-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1-
# Flux
1+
<div align="center">
2+
<h3 align="center">Flux</h3>
3+
<p align="center">
4+
LLM power tool.
5+
<br />
6+
<br />
7+
<a href="https://twitter.com/transmissions11/status/1640775967856803840">Announcement</a>
8+
·
9+
<a href="http://flux.paradigm.xyz">Try Online</a>
10+
·
11+
<a href="https://github.com/transmissions11/flux/issues">Report a Bug</a>
12+
</p>
13+
</div>
214

3-
Generate multiple completions per prompt in a tree structure and explore the best ones in parallel.
15+
<br />
16+
17+
![A screenshot of a Flux workspace.](/public/meta-full.png)
18+
19+
## About
20+
21+
Flux is a power tool for interacting with large language models (LLMs) that generates multiple completions per prompt in a tree structure and lets you explore the best ones in parallel. Flux's tree structure allows you to get a wider variety of creative responses, test out different prompts with the same shared context, and use inconsistencies to identify where the model is uncertain. It also provides a robust set of keyboard shortcuts, allows setting the system message and editing GPT messages, autosaves to local storage, uses the OpenAI API directly, and is 100% open source and MIT licensed.
22+
23+
## Usage
24+
25+
Visit [flux.paradigm.xyz](https://flux.paradigm.xyz) to try Flux online or follow the instructions below to run it locally.
26+
27+
## Running Locally
28+
29+
```sh
30+
git clone https://github.com/transmissions11/flux.git
31+
npm install
32+
npm run dev
33+
```
34+
35+
## Contributing
36+
37+
See the [open issues](https://github.com/transmissions11/flux/issues) for a list of proposed features (and known issues).

public/meta-full.png

136 KB
Loading

0 commit comments

Comments
 (0)