diff --git a/README.md b/README.md index 10a0186..797ed17 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ ------ -**DISCLAIMER: This project is very much a Work In Progress. It is for meetup hosts pioneering Handmade Meetups. Hosts are expected to be programmers who are comfortable running and editing command-line programs. You can get help or give feedback in the [`#meetups`](https://discord.com/channels/239737791225790464/424523844016144394) channel of the [Handmade Network Discord](https://discord.gg/hmn). -** - +**DISCLAIMER: This project is very much a Work In Progress. It is for meetup hosts pioneering Handmade Meetups. Hosts are expected to be programmers who are comfortable running and editing command-line programs. You can get help or give feedback in the [`#meetups`](https://discord.com/channels/239737791225790464/424523844016144394) channel of the [Handmade Network Discord](https://discord.gg/hmn).** ------ # send_mail -`send_mail.py` lets you email a [meetup group](https://handmadecities.com/meetups) using Handmade Cities branding. The script is for Handmade meetup hosts. You can email an invite to your meetup group like so: +`send_mail.py` lets you email a [meetup group](https://handmadecities.com/meetups) using Handmade Cities branding. The script is for Handmade meetup hosts. You can send an invite to your meetup group like so: -> python3 send_mail.py --subject SUBJECT --body BODY +`> python3 send_mail.py --subject SUBJECT --body BODY` where SUBJECT is the subject of your email and BODY is the file containing its contents. Plain text or HTML is supported. Your email will automatically include the Handmade Cities branding along with unsubscribe links! Note that you can dump the mailing list of your meetup group so far: -> python3 send_mail.py --dump +`> python3 send_mail.py --dump` -This list grows automatically as more people sign up for your city (at handmadecities.com/meetups) +This list grows automatically as more people sign up for your city. ## app.ini `send_mail` requires a companion `app.ini` file. It has the requisite secret credentials to be able to dump the mailing list and otherwise send the actual emails. -Below is how the file looks like. Anything secret is censored as `xxx`: +Below is how the file looks like. Note that anything secret is censored as `xxx`: ``` ; User Constants - Update as needed @@ -42,4 +40,4 @@ SENDER_EMAIL = abner@handmadecities.com MESSAGE_STREAM = xxx ``` -LIVE is false by default, in which case the script only sends an email to whichever address is in TEST_EMAIL. Set it to true once you're ready to mass-email your entire meetup group. +`LIVE` is false by default, in which case the script only sends an email to the address in TEST_EMAIL. Set this to true when you're ready to mass-email your group.