> For the complete documentation index, see [llms.txt](https://pecans.darrelopry.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pecans.darrelopry.com/main/docs.md).

# Pecans Documentation

Pecans is a simple (and smart) application to serve desktop-application releases.

It uses GitHub as a backend to store assets, and it can easily be deployed to Heroku as a stateless service. GitHub private repositories are supported (useful to store releases of a closed-source application available on GitHub).

![Schema](/files/-ManQefr6HNTFWhwqlaw)

Please make sure that you use the documentation that match your Pecans version (Latest version is **{{ book.version }}**).

### FAQ

There are questions that are asked quite often, [check this out before creating an issue](/main/docs/faq.md).

### Help and Support

We're always happy to help out with any questions you might have. You can ask a question or signal an issue on [GitHub](https://github.com/dopry/pecans/issues).

### Guides

We've created a few guides to help you getting started:

* [Migrating from 1.x to 2.x](/main/docs/migrating-2.0.md)
* [Deploy Pecans](/main/docs/deploy.md)
* [Upload release's assets](/main/docs/assets.md)
* [Setup GitHub integration](/main/docs/github.md)
* [Setup macOS Auto-Updater](/main/docs/update-osx.md)
* [Setup Windows Auto-Updater](/main/docs/update-windows.md)
* [API](/main/docs/api.md)
* [Use it as a Node.js module](/main/docs/module.md)

***

Using Pecans for your application? [Add it to the list](/main/docs/using-it.md).