# 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](https://3806533860-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-ManDcVlAUWlZ5A3mnAu%2Fsync%2Fd84072a217e28ccbc49416b617bf96178af5623a.png?generation=1622213045718393\&alt=media)

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

## FAQ

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

## 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:

* [Deploy Pecans](https://pecans.darrelopry.com/main/docs/deploy)
* [Upload release's assets](https://pecans.darrelopry.com/main/docs/assets)
* [Setup GitHub integration](https://pecans.darrelopry.com/main/docs/github)
* [Setup OS X Auto-Updater](https://pecans.darrelopry.com/main/docs/update-osx)
* [Setup Windows Auto-Updater](https://pecans.darrelopry.com/main/docs/update-windows)
* [Debug API](https://pecans.darrelopry.com/main/docs/api)
* [Use it as a Node.js middleware](https://pecans.darrelopry.com/main/docs/module)

Using Pecans for your application? [Add it to the list](https://pecans.darrelopry.com/main/docs/using-it).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pecans.darrelopry.com/main/docs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
