diff --git a/docs/README.md b/docs/README.md index cf3be38..fca3768 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,13 @@ ---

- Logo + Logo
- CompanyLogo -
- how2meet + title

- Frictionless event manager + The frictionless event manager

@@ -17,14 +15,10 @@ Table of Contents - [About](#about) - - [Description](#description) - [Motivation](#motivation) - [Features](#features) - [Roadmap](#roadmap) - [Built With](#built-with) -- [Getting Started](#getting-started) - - [Tutorial](#tutorial) - - [Screenshots](#screenshots) - [Roadmap](#roadmap) - [Maintainers](#maintainers) - [License](#license) @@ -38,11 +32,14 @@ **how2meet** is a *frictionless* event manager--meaning it is simple, free, easy to use, and does **NOT** require you or your guests to: - Create an account +- Give out your personal information to a service you're not sure that you can trust - Download an app +Just create your event and send a link with whatever service you choose! + ## Motivation -### __Facebook is dead:__ _But Facebook Events was :fire:_ +### __Facebook is dead :skull: :__ _But Facebook Events was :fire:_ - Facebook Events - No one wants to download an app - Planning a reunion with a big group of distributed, busy friends @@ -50,10 +47,10 @@ - ## Features -- [ ] Host an event at a specific location, date, and time -- [ ] Send invites to guests via text, email, or web interface (link) -- [ ] Track RSVP responses, nudge those who haven't responded -- [ ] Admin access to limit attendees, kick out unknowns, change event details, and more! +- [x] Host an event at a specific location, date, and time +- [x] Send invites to guests via link +- [x] Track RSVP responses +- [x] Admin access to change event details ## Roadmap - [ ] When2meet-style group scheduler @@ -61,13 +58,19 @@ - [ ] Polls - [ ] Photos and comments - [ ] AI-powered planning assistant +- [ ] Alternative communication paths (text, email, whatsapp, etc.) +- [ ] Nudge guests who haven't responded +- [ ] Geo-location search and presentation +- [ ] Admins to limit attendees, kick out unknowns ## Built With -| Library | Use | Source | -|-----------------------------------------|----------------|-------------------------------------------------| -| [nicegui](https://nicegui.io) | GUI | https://github.com/zauberzeug/nicegui/tree/main | -| [FastAPI](https://fastapi.tiangolo.com) | Backend | https://github.com/tiangolo/fastapi | -| [Render](https://render.com) | Infrastructure | https://github.com/renderinc | +| Library | Use | Source | +|------------------------------------------|----------------|-------------------------------------------------| +| [nicegui](https://nicegui.io) | GUI | https://github.com/zauberzeug/nicegui/tree/main | +| [FastAPI](https://fastapi.tiangolo.com) | Backend | https://github.com/tiangolo/fastapi | +| [Render](https://render.com) | Infrastructure | https://github.com/renderinc | +| [SQLAlchemy](https://www.sqlalchemy.org) | ORM | https://github.com/sqlalchemy/sqlalchemy | +| [Postgres](https://www.postgresql.org) | Database | https://github.com/postgres | # Maintainers | Name | Email | @@ -79,6 +82,6 @@ # License [GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/) -# Acknowledgements / References +# Acknowledgements [when2meet](https://www.when2meet.com) diff --git a/docs/assets/2.png b/docs/assets/2.png new file mode 100644 index 0000000..ce4b77c Binary files /dev/null and b/docs/assets/2.png differ diff --git a/docs/assets/company-logo.png b/docs/assets/company-logo.png deleted file mode 100644 index fe1f200..0000000 Binary files a/docs/assets/company-logo.png and /dev/null differ diff --git a/docs/assets/h.png b/docs/assets/h.png new file mode 100644 index 0000000..e871ccf Binary files /dev/null and b/docs/assets/h.png differ diff --git a/docs/assets/h2m-logo.png b/docs/assets/h2m-logo.png deleted file mode 100644 index 7199c95..0000000 Binary files a/docs/assets/h2m-logo.png and /dev/null differ diff --git a/docs/assets/h2m_logo.png b/docs/assets/h2m_logo.png new file mode 100644 index 0000000..2d6cd81 Binary files /dev/null and b/docs/assets/h2m_logo.png differ diff --git a/docs/assets/h2m_logo.pxd b/docs/assets/h2m_logo.pxd new file mode 100644 index 0000000..ec4ce8b Binary files /dev/null and b/docs/assets/h2m_logo.pxd differ diff --git a/docs/assets/h2m_logo_alt.png b/docs/assets/h2m_logo_alt.png new file mode 100644 index 0000000..54b2e4b Binary files /dev/null and b/docs/assets/h2m_logo_alt.png differ diff --git a/docs/assets/h2m_logo_alt.pxd b/docs/assets/h2m_logo_alt.pxd new file mode 100644 index 0000000..b1bab97 Binary files /dev/null and b/docs/assets/h2m_logo_alt.pxd differ diff --git a/docs/assets/how2meet.png b/docs/assets/how2meet.png new file mode 100644 index 0000000..a1d2e57 Binary files /dev/null and b/docs/assets/how2meet.png differ diff --git a/docs/assets/company-logo.pxd b/docs/assets/title.pxd similarity index 58% rename from docs/assets/company-logo.pxd rename to docs/assets/title.pxd index a08bc85..061dc11 100644 Binary files a/docs/assets/company-logo.pxd and b/docs/assets/title.pxd differ