Skip to content

Commit

Permalink
🐛 fix(readme): Fix readme template to preserve template notation
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaultyou committed Oct 19, 2024
1 parent 54f55e2 commit d817e9d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 22 deletions.
36 changes: 15 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,8 @@ Welcome to the **Prompt Library**, a collection of categorized AI prompts for ea

## 📚 Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [🎯 Purpose & Features](#-purpose--features)
- [⚡ Quick Start](#-quick-start)
- [🛠️ How It Works](#-how-it-works)
- [🖥️ CLI Usage](#-cli-usage)
- [Interactive Menu](#interactive-menu)
- [List Prompts and Categories](#list-prompts-and-categories)
- [Sync Personal Library](#sync-personal-library)
- [Execute Prompts](#execute-prompts)
- [📂 Prompt Library Example](#-prompt-library-example)
- [🚀 Getting Started](#-getting-started)
- [🧩 Using Fragments](#-using-fragments)
- [⚙️ Metadata Customization](#-metadata-customization)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- START doctoc -->
<!-- END doctoc -->

## 🎯 Purpose & Features

Expand Down Expand Up @@ -71,7 +54,18 @@ Detailed setup instructions in [Getting Started](#-getting-started).
prompt-library-cli
```

For all CLI options, run:

```sh
prompt-library-cli --help
```

### List Prompts and Categories

```sh
prompt-library-cli prompts --list
prompt-library-cli prompts --categories
```

### Sync Personal Library

Expand Down Expand Up @@ -115,9 +109,9 @@ prompt-library-cli execute --help
<details>
<summary><strong>Coding</strong></summary>
- [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimized git branch names based on project context and user requirements
- [Git Commit Message Agent](prompts/git_commit_message_agent/README.md) - Generates precise and informative git commit messages following Conventional Commits specification
- [GitHub Issue Creator](prompts/github_issue_creator_agent/README.md) - Creates comprehensive and actionable GitHub issues based on provided project information
- [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimized git branch names based on project context and user requirements
- [Software Architect Code Reviewer](prompts/software_architect_code_reviewer/README.md) - Generates comprehensive pull requests with architectural analysis and optimization suggestions
- [Software Development Expert Agent](prompts/software_dev_expert_agent/README.md) - Provides expert, adaptive assistance across all aspects of the software development lifecycle.

Expand Down Expand Up @@ -193,7 +187,7 @@ prompt-library-cli execute --help
Fragments are reusable prompt components:

1. Create `.md` files in `fragments` directory under the appropriate [categories](/src/system_prompts/prompt_analysis_agent/prompt.md)).
2. Reference in prompts: `` (e.g., `` for `awesome_guidelines.md`).
2. Reference in prompts: `{{FRAGMENT_NAME}}` (e.g., `{{AWESOME_GUIDELINES}}` for `awesome_guidelines.md`).
3. Manage and use via CLI.

## ⚙️ Metadata Customization
Expand Down
2 changes: 1 addition & 1 deletion src/app/templates/main_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ prompt-library-cli execute --help
Fragments are reusable prompt components:

1. Create `.md` files in `fragments` directory under the appropriate [categories](/src/system_prompts/prompt_analysis_agent/prompt.md)).
2. Reference in prompts: `{{FRAGMENT_NAME}}` (e.g., `{{AWESOME_GUIDELINES}}` for `awesome_guidelines.md`).
2. Reference in prompts: `{% raw %}{{FRAGMENT_NAME}}{% endraw %}` (e.g., `{% raw %}{{AWESOME_GUIDELINES}}{% endraw %}` for `awesome_guidelines.md`).
3. Manage and use via CLI.

## ⚙️ Metadata Customization
Expand Down

0 comments on commit d817e9d

Please sign in to comment.