Skip to content

Commit

Permalink
fix(README): removign scapes using on AI generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Estrada Irribarra, Rodrigo Andres committed Oct 13, 2024
1 parent f68a02b commit 121d328
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,65 +31,65 @@ With StoryCraftr, you'll never feel stuck again. Let AI guide your creative proc
### Installation

1. **Clone the repository**:
@@```bash
```bash
git clone https://github.com/your-repo/storycraftr.git
cd storycraftr
```@@
```

2. **Install dependencies using Poetry**:
@@```bash
```bash
poetry install
```@@
```

3. **Create a `.env` file** to store your OpenAI API key:
@@```bash
```bash
touch .env
echo "OPENAI_API_KEY=your-openai-api-key" >> .env
```@@
```

4. **Run the CLI**:
@@```bash
```bash
poetry run storycraftr --help
```@@
```

## Usage

StoryCraftr allows you to create, update, and manage every aspect of your book through simple CLI commands. Here are some examples:

### Worldbuilding

@@```bash
```bash
poetry run storycraftr my-book worldbuilding geography "Describe the geography of a futuristic dystopia" en
```@@
```

### Outline

@@```bash
```bash
poetry run storycraftr my-book outline general_outline "Outline a sci-fi thriller where humanity battles AI overlords" en
```@@
```

### Chapters

@@```bash
```bash
poetry run storycraftr my-book chapters chapter "Write chapter one of a space opera" en 1
```@@
```

### Updating Knowledge

If you've made changes to your book's structure, you can update the agent's knowledge with:
@@```bash
```bash
poetry run storycraftr my-book update
```@@
```
## Contributing
We welcome contributions of all kinds! Whether you’re a developer, writer, or simply interested in improving the tool, you can help. Here’s how you can contribute:
1. **Fork the repository** and create your branch:
@@```bash
```bash
git checkout -b feature/YourFeature
```@@
```
2. **Make your changes**, ensuring all tests pass.
Expand Down

0 comments on commit 121d328

Please sign in to comment.