Skip to content

Commit

Permalink
📝 docs: Update README with usage instructions and add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaultyou committed Sep 28, 2024
1 parent d19ff65 commit e52594c
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 1 deletion.
58 changes: 57 additions & 1 deletion .github/templates/readme_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 📚 Prompt Library

Welcome to my **Prompt Library**. This repository contains a collection of prompts categorized for easy navigation.
Welcome to the **Prompt Library**. This repository contains a collection of AI prompts categorized for easy navigation and reuse.

## 🗂️ Categories

Expand All @@ -14,3 +14,59 @@ Welcome to my **Prompt Library**. This repository contains a collection of promp
{% endfor %}

{% endfor %}

## 🚀 Getting Started

This repository is designed to be easily forked and customized for your own use. Follow these steps to get started:

1. **Fork the Repository**: Click the "Fork" button at the top right of this page to create a copy of this repository in your own GitHub account.

2. **Clone Your Fork**: Clone the forked repository to your local machine using:

```
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
```

3. **Set Up Anthropic API Key**:
- Go to your repository's settings on GitHub.
- Navigate to "Secrets and variables" > "Actions".
- Create a new repository secret named `ANTHROPIC_API_KEY` and paste your Anthropic API key as the value.

4. **Add Your Own Prompts**:
- Create a new file in the `prompts` directory named `prompt.md`.
- Write your prompt content in this file.
- Commit and push your changes to GitHub.

5. **Let GitHub Actions Work**:
- The GitHub Actions workflow will automatically generate metadata for your new prompt.
- It will create a new directory for your prompt, move the `prompt.md` file into it, and create `metadata.yml` and `view.md` files.
- The README will be automatically updated to include your new prompt.

6. **Customize as Needed**:
- You can modify the templates in the `.github/templates` directory to change how prompts are displayed.
- Update the scripts in `.github/scripts` to alter the metadata generation or view update process.

## 🛠️ How It Works

- When you add or update a `prompt.md` file in the `prompts` directory, GitHub Actions are triggered.
- The `generate_metadata.py` script uses the Anthropic API to analyze your prompt and generate metadata.
- The `update_views.py` script creates or updates the `view.md` files for each prompt and updates the main README.
- All changes are automatically committed back to the repository.

## 🔧 Customizing Metadata Extraction

The system prompt used to extract metadata from your prompts can be customized. This prompt is located at:

```
.github/prompts/ai_prompt_analyzer_and_output_generator/prompt.md
```

You can modify this file to change how metadata is extracted from your prompts. This allows you to tailor the metadata generation process to your specific needs or to extract additional information from your prompts.

## 📝 Contributing

Contributions to improve the templates, scripts, or overall structure of this prompt library are welcome! Please feel free to submit issues or pull requests.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
15 changes: 15 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
MIT License
Copyright (c) 2024 Thibault YOU

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ADDITIONAL DISCLAIMER FOR PROMPT-LIBRARY:
The author(s) of this software expressly disclaim any and all liability for any damages or losses arising from the use, attempted use, or inability to use this software or any part thereof, including but not limited to any prompts, generated content, or metadata produced by or used with this software. By using this software, you acknowledge that you are doing so entirely at your own risk, and you agree to hold the author(s) harmless from any and all consequences that may result from your use of the software.

This software may generate or be used to generate content using AI models. The author(s) do not guarantee the accuracy, completeness, or usefulness of any generated content. Users are solely responsible for evaluating and using any generated content appropriately.

The author(s) are not responsible for any actions taken by users based on the content generated by or used with this software. Users are advised to review and validate any generated content before use in any critical or sensitive applications.

0 comments on commit e52594c

Please sign in to comment.