8b45c0a51963e5944bc65444a1cad31db9c462f5 — José Alberto Orejuela García 2 years ago a6bdfa9
Add readme
1 files changed, 42 insertions(+), 0 deletions(-)

A README.md => README.md +42 -0
@@ 0,0 1,42 @@

This is a bot that will be able to handle different requests regarding Astronomy Picture Of the Day in https://apod.nasa.gov/. It's still work in progress, not even in an alpha stage.

## Deprecated Telegram version

This bot used to be only a Telegram bot. I have that version running on a server. You can find it in https://t.me/ApodNasaBot, and the code in deprecated-\* branches. Besides, the bot cannot interact, it only sends the picture everyday to the ones already subscribed. If you are interested in subscribing, just let me know. Beware of bugs.

## New version

The aim of this new version is to make a new bot compatible with many platforms released under AGPL and with help of as many contributors as possible. I want to make real free software, with a community behind, even a little one. ;)

### Expected features

The bot should be able to:

1.  Download automatically the APOD from NASA, including description and links inside it.
1.  Send last picture.
1.  Manage subscriptions, including:
    -   Subscribe.
    -   Unsubscribe.
    -   Send automatically the picture to subscribed users at the time they choose.
1.  Send the picture of a given date.
1.  Ping.
1.  Log all messages received and sent.
1.  Manage admins: add, remove, send admin list.
1.  Send log lines to an admin, when asked.
1.  Redownload APOD when an admin asks to, keeping a backup of the old one.
1.  Send subscriber list to an admin, when asked.

# Contribute

Did you find a bug? Feel free to report it to the mailing list [~josealberto4444/apodnasabot@lists.sr.ht][mailing-list] if it's not reported yet (take a look at the [etiquette][]).

Do you want to contribute to the code? Glad to hear it, that's the purpose of putting it here! Simply send a patch to [~josealberto4444/apodnasabot@lists.sr.ht][mailing-list]. Take a look at https://git-send-email.io/ if you need help. =)

[etiquette]: https://man.sr.ht/lists.sr.ht/etiquette.md
[mailing-list]: mailto:~josealberto4444/apodnasabot@lists.sr.ht