mirror of
https://github.com/mudler/LocalAI
synced 2026-04-21 13:27:21 +00:00
docs: make examples repository link more prominent (#8895)
docs: make examples repository link more prominent in README Add a badge-style button link to the examples repository in the main README and expand examples/README.md with example categories and quick-start links to help new users discover the examples repo. Co-authored-by: localai-bot <localai-bot@noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
316bacdff5
commit
95aef32492
2 changed files with 27 additions and 1 deletions
|
|
@ -54,6 +54,12 @@
|
||||||
|
|
||||||
[](https://github.com/go-skynet/LocalAI/actions/workflows/test.yml)[](https://github.com/go-skynet/LocalAI/actions/workflows/release.yaml)[](https://github.com/go-skynet/LocalAI/actions/workflows/image.yml)[](https://github.com/go-skynet/LocalAI/actions/workflows/bump_deps.yaml)[](https://artifacthub.io/packages/search?repo=localai)
|
[](https://github.com/go-skynet/LocalAI/actions/workflows/test.yml)[](https://github.com/go-skynet/LocalAI/actions/workflows/release.yaml)[](https://github.com/go-skynet/LocalAI/actions/workflows/image.yml)[](https://github.com/go-skynet/LocalAI/actions/workflows/bump_deps.yaml)[](https://artifacthub.io/packages/search?repo=localai)
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://github.com/mudler/LocalAI-examples" target="blank">
|
||||||
|
<img src="https://img.shields.io/badge/📦_Examples_Repository-Browse_Ready--to--Run_Examples-blue?style=for-the-badge" alt="LocalAI Examples Repository"/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
**LocalAI** is the free, Open Source OpenAI alternative. LocalAI act as a drop-in replacement REST API that's compatible with OpenAI (Elevenlabs, Anthropic... ) API specifications for local AI inferencing. It allows you to run LLMs, generate images, audio (and not only) locally or on-prem with consumer grade hardware, supporting multiple model families. Does not require GPU. It is created and maintained by [Ettore Di Giacinto](https://github.com/mudler).
|
**LocalAI** is the free, Open Source OpenAI alternative. LocalAI act as a drop-in replacement REST API that's compatible with OpenAI (Elevenlabs, Anthropic... ) API specifications for local AI inferencing. It allows you to run LLMs, generate images, audio (and not only) locally or on-prem with consumer grade hardware, supporting multiple model families. Does not require GPU. It is created and maintained by [Ettore Di Giacinto](https://github.com/mudler).
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,23 @@
|
||||||
# LocalAI Examples
|
# LocalAI Examples
|
||||||
|
|
||||||
LocalAI examples were moved to a dedicated repository: https://github.com/mudler/LocalAI-examples
|
The examples for LocalAI have moved to a dedicated repository for easier discovery and maintenance.
|
||||||
|
|
||||||
|
## **[Browse Examples](https://github.com/mudler/LocalAI-examples)**
|
||||||
|
|
||||||
|
The examples repository contains ready-to-run configurations and tutorials covering:
|
||||||
|
|
||||||
|
- **Chat & Text Generation** - LLM conversations, function calling, constrained grammars
|
||||||
|
- **Image Generation** - Stable Diffusion, diffusers, image-to-image
|
||||||
|
- **Audio** - Text-to-speech, speech-to-text, voice cloning
|
||||||
|
- **Embeddings & RAG** - Vector databases, retrieval-augmented generation
|
||||||
|
- **Integrations** - Langchain, Discord bots, Slack bots, Telegram bots
|
||||||
|
- **Advanced** - P2P inferencing, Kubernetes deployments, API usage
|
||||||
|
|
||||||
|
Each example includes configuration files and step-by-step instructions to get started quickly.
|
||||||
|
|
||||||
|
### Quick Links
|
||||||
|
|
||||||
|
- **Examples Repository**: https://github.com/mudler/LocalAI-examples
|
||||||
|
- **Documentation**: https://localai.io/
|
||||||
|
- **Model Gallery**: https://models.localai.io/
|
||||||
|
- **Getting Started**: https://localai.io/basics/getting_started/
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue