Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seemywingz committed Dec 21, 2024
1 parent e4b765c commit 6b1e2dd
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 22 deletions.
37 changes: 16 additions & 21 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Visit your [API Keys](https://platform.openai.com/account/api-keys) page to retr
###### ℹ️ You can omit keys for unused API endpoints
```bash
OPENAI_API_KEY={YOUR OPENAI API KEY}
PRINTIFY_API_KEY={YOUR PRINTIFY API KEY}
DISCORD_API_KEY={YOUR DISCORD BOT API KEY}
DISCORD_PUB_KEY={YOUR DISCORD BOT PUB KEY}
```
Expand All @@ -30,16 +29,16 @@ DISCORD_PUB_KEY={YOUR DISCORD BOT PUB KEY}
## Ponder a single thought
### CLI
```bash
ponder --prompt "AI is Amazing"
ponder "What is AI"
```
### Docker
#### Running ponder in docker is exactly the same, but you have to provide the env vars when running
```bash
docker run -e OPENAI_API_KEY=$OPENAI_API_KEY ghcr.io/seemywingz/ponder:latest --prompt "Ai is Amazing"
docker run -e OPENAI_API_KEY=$OPENAI_API_KEY ghcr.io/seemywingz/ponder:latest "What is AI"
```
#### Example Output
```bash
AI is indeed amazing. It has the potential to revolutionize many industries, from healthcare to transportation. AI can help automate mundane tasks, allowing humans to focus on more complex and creative tasks. AI can also be used to analyze large amounts of data quickly and accurately, helping to make better decisions. AI can also be used to create personalized experiences for customers, making them feel more connected to a company or product.
AI, or Artificial Intelligence, refers to the simulation of human intelligence processes by machines, especially computer systems. These processes include learning (the acquisition of information and rules for using the information), reasoning (using the rules to reach approximate or definite conclusions), and self-correction.
```

## A small chat
Expand All @@ -48,22 +47,19 @@ ponder --convo
```
#### Example Ouput
```bash
You:
Hello, Ponder
Ponder:
Hello! How can I assist you today?

Ponder:
Hello there! How can I help you?
You:
You are so helpful

You:
you already have thank you

Ponder:
Thank you for your kind words!
Ponder:
Thank you for your kind words! I'm here to help. If you have any questions or need assistance with something, feel free to ask.
```
## Image Generation
```bash
ponder image -p "a ferocious cat with wings and fire"
ponder image "a ferocious cat with wings and fire"
```
#### Example Ouput
```bash
Expand All @@ -73,13 +69,13 @@ ponder image -p "a ferocious cat with wings and fire"
### You can always refer to the `--help` menu as well.
```yaml
Ponder
GitHub: https://github.com/seemywingz/ponder
App Version: v0.3.0
App Version: v0.4.0
Ponder uses OpenAI's API to generate text responses to user input.
You can use Ponder as a Discord chat bot or to generate images using the DALL-E API.
Or whatever else you can think of...
Or whatever else you can think of. 🤔

Usage:
ponder [flags]
Expand All @@ -92,16 +88,15 @@ Available Commands:
discord-bot Discord Chat Bot Integration
help Help about any command
image Generate an image from a prompt
printify Interact with the Printify API
tts OpenAI Text to Speech API - TTS

Flags:
--config string config file
-c, --convo Conversational Style chat
-h, --help help for ponder
-x, --perform Attempt to perform the response as cli command
-p, --prompt string Prompt AI generation
-s, --say Say text out loud (MacOS only)
--narrate Narrate the response using TTS and the default audio output
-v, --verbose verbose output
--voice string Voice to use: alloy, ash, coral, echo, fable, onyx, nova, sage and shimmer (default "onyx")

Use "ponder [command] --help" for more information about a command.
```
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
)

var ponderMessages = []goai.Message{}
var APP_VERSION = "v0.1.0"
var APP_VERSION = "v0.4.0"
var ai *goai.Client

var verbose,
Expand Down

0 comments on commit 6b1e2dd

Please sign in to comment.