Skip to content

Commit

Permalink
Project clean up.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Nov 11, 2024
1 parent d1d925c commit 293637c
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 110 deletions.
5 changes: 0 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,3 @@ readmeai/cli/commands_line.py
readmeai/cli/interactive.py
readmeai/config/settings/prompts
readmeai/config/settings/templates

# Project Assets
docs/docs/assets/svg/readme-ai-animated.svg
docs/docs/assets/svg/readme-ai-banner.svg
docs/docs/assets/svg/readme-ai-cosmic.svg
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-gradient.svg" alt="readme-ai-bannerlogo" width="80%">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-gradient.svg" alt="readme-ai-banner-logo" width="80%">
</p>

<p align="center">
Expand Down
57 changes: 0 additions & 57 deletions docs/docs/assets/svg/readme-ai-logo-animated.svg

This file was deleted.

32 changes: 0 additions & 32 deletions docs/docs/assets/svg/readme-ai-logo-gradient.svg

This file was deleted.

14 changes: 7 additions & 7 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="hero-section">
<div class="hero-content">
<div class="logo-container">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-animated.svg"
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-gradient.svg"
alt="readme-ai">
</div>
<h2 class="tagline">
Expand Down Expand Up @@ -46,16 +46,16 @@
<h3>Highly Customizable</h3>
<p>Choose from dozens of styling options, badges, and templates</p>
</div>
<div class="feature-card">
<div class="feature-icon">🤖</div>
<h3>Flexible Backends</h3>
<p>Seamlessly integrate with <code>OpenAI</code>, <code>Anthropic</code>, <code>Google Gemini</code>, and <code>Ollama</code></p>
</div>
<div class="feature-card">
<div class="feature-icon">🌐</div>
<h3>Language Agnostic</h3>
<p>Works with any programming language or framework</p>
</div>
<div class="feature-card">
<div class="feature-icon">🤖</div>
<h3>Multi-LLM Support</h3>
<p>Compatible with OpenAI, Ollama, Anthropic, and Google Gemini</p>
</div>
</div>
<div class="quick-start">
<h2>Quick Start</h2>
Expand All @@ -66,7 +66,7 @@
</div>
<div class="step">
<h3>2. Generate Documentation</h3>
<code>readmeai --repository <your-repo-url> --output README-AI.md</code>
<code>readmeai --repository https://github.com/user/project-name --output README-AI.md</code>
</div>
</div>
</div>
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Readme-ai harnesses the power of artificial intelligence to automatically genera
## Integration and Flexibility

- **Extensible**: Customize and extend readme-ai to fit your specific documentation needs.
- **Multiple AI Backends**: Choose from various AI providers (OpenAI, Ollama, Google Gemini) or use the offline mode for sensitive projects.
- **Flexible Backends**: Choose from various AI providers (OpenAI, Ollama, Google Gemini) or use the offline mode for sensitive projects.
- **Language Agnostic**: Works with a wide range of programming languages and project types, ensuring compatibility with your existing codebase.

## Community-Driven Development
Expand All @@ -41,12 +41,10 @@ Readme-ai harnesses the power of artificial intelligence to automatically genera
2. **Customizable Output**: Offers numerous CLI options for tailoring the README to your project's needs:

- Badge styles and colors

- Header designs

- Table of contents styles

- Project logos
- README header templates
- Apply an emoji themes
- Add a table of contents
- Generate a project logo

3. **Language Agnostic**: Works with a wide range of programming languages and project types, automatically detecting and summarizing key aspects of your codebase.

Expand All @@ -57,7 +55,7 @@ Readme-ai harnesses the power of artificial intelligence to automatically genera
- Dependencies
- Setup instructions

5. **Multi-LLM Support**: Compatible with various language model APIs, including:
5. **Flexible Backends**: Compatible with various language model APIs, including:

- OpenAI
- Ollama
Expand All @@ -68,3 +66,5 @@ Readme-ai harnesses the power of artificial intelligence to automatically genera
6. **Offline Mode**: Generate a basic README structure without requiring an internet connection or API calls.

7. **Markdown Expertise**: Leverages best practices in Markdown formatting for clean, professional-looking documentation.

---

0 comments on commit 293637c

Please sign in to comment.