Skip to content

Commit 40c0b86

Browse files
authored
Update README
1 parent ad50f8c commit 40c0b86

File tree

1 file changed

+68
-108
lines changed

1 file changed

+68
-108
lines changed

README.md

Lines changed: 68 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,39 @@
11
<div align="center">
2-
🌟 A star would be much appreciated! 🌟
3-
</div>
2+
<div align="center">
43

5-
<p align="center">
6-
<img src="https://hievents-public.s3.us-west-1.amazonaws.com/website/hi-events-rainbow.png?v=1" alt="Hi.Events Logo" width="200px">
7-
</p>
4+
💖 **Found Hi.Events helpful?**
5+
⭐ Please consider giving us a star to support the project! ⭐
86

9-
<h3 align="center">Hi.Events</h3>
7+
</div>
108

11-
<p align="center">
12-
<a href="https://app.hi.events/event/2/hievents-conference-2030?utm_source=gh-readme&utm_content=demo-link">Demo Event 🌟</a> • <a href="https://hi.events?utm_source=gh-readme&utm_content=website-link">Website 🌎</a> • <a href="https://hi.events/docs?utm_source=gh-readme&utm_content=documentation-link">Documentation 📄</a> • <a href="https://hi.events/docs/getting-started?utm_source=gh-readme&utm_content=installation=link">Installation ⚙️</a>
9+
<p>
10+
<img src="https://hievents-public.s3.us-west-1.amazonaws.com/website/hi-events-rainbow.png?v=1" alt="Hi.Events Logo" width="200px">
1311
</p>
1412

15-
<h3 align="center">
16-
Open-source event management and ticketing platform.
17-
</h3>
18-
19-
<div align="center">
13+
<h1>Hi.Events</h1>
14+
<h3>Open-source event management and ticketing platform to sell tickets online for events of all sizes</h3>
2015

2116
[![Share on AddToAny](https://img.shields.io/badge/Share%20Hi.Events-blue)](https://www.addtoany.com/share?linkurl=https://github.com/HiEventsDev/hi.events)
2217
[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/HiEventsTickets)](https://x.com/HiEventsTickets)
23-
<br/>
2418
[![Hi.Events docs](https://img.shields.io/badge/docs-hi.events-blue)](https://hi.events/docs)
2519
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://github.com/HiEventsDev/Hi.Events/blob/develop/LICENCE)
2620
[![GitHub Release](https://img.shields.io/github/v/release/HiEventsDev/hi.events?include_prereleases)](https://github.com/HiEventsDev/hi.events/releases)
2721
[![Run Unit Tests](https://github.com/HiEventsDev/hi.events/actions/workflows/unit-tests.yml/badge.svg?event=push)](https://github.com/HiEventsDev/hi.events/actions/workflows/unit-tests.yml)
2822
[![Docker Pulls](https://img.shields.io/docker/pulls/daveearley/hi.events-all-in-one)](https://hub.docker.com/r/daveearley/hi.events-all-in-one)
2923

30-
</div>
24+
<p>
25+
<a href="https://app.hi.events/event/2/hievents-conference-2030?utm_source=gh-readme&utm_content=try-cloud-link">Try Cloud ☁️</a> •
26+
<a href="https://app.hi.events/event/2/hievents-conference-2030?utm_source=gh-readme&utm_content=demo-link">Demo Event 🌟</a> •
27+
<a href="https://hi.events?utm_source=gh-readme&utm_content=website-link">Website 🌎</a> •
28+
<a href="https://hi.events/docs?utm_source=gh-readme&utm_content=documentation-link">Documentation 📄</a> •
29+
<a href="https://hi.events/docs/getting-started?utm_source=gh-readme&utm_content=installation=link">Installation ⚙️</a>
30+
</p>
3131

32-
<div align="center">
33-
<a href="https://trendshift.io/repositories/10563" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10563" alt="HiEventsDev%2Fhi.events | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
32+
<a href="https://trendshift.io/repositories/10563" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10563" alt="HiEventsDev%2Fhi.events | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
3433
</div>
3534

3635
<hr/>
37-
<p align="center" style="text-align: center;">
36+
<p align="center">
3837
<a href="README.de.md">Deutsch</a> |
3938
<a href="README.pt.md">Português</a> |
4039
<a href="README.fr.md">Français</a> |
@@ -44,85 +43,58 @@
4443
</p>
4544
<hr/>
4645

47-
## Table of Contents
48-
49-
- [Introduction](#-introduction)
50-
- [Features](#-features)
51-
- [Getting Started](#-getting-started)
52-
- [Change Log](#-change-log)
53-
- [Contributing](#-contributing)
54-
- [FAQ](#-faq)
55-
5646
## 📚 Introduction
5747

58-
<a href="https://hi.events">Hi.Events</a> is a feature-rich, self-hosted event management and ticketing platform. From conferences to club nights,
59-
Hi.Events is designed to help you create, manage, and sell tickets for events of all sizes.
48+
<a href="https://hi.events">Hi.Events</a> is a feature-rich, self-hosted event management and ticketing platform that helps you sell tickets online for all types of events. From conferences and workshops to club nights and concerts, Hi.Events provides everything you need to create, manage, and monetize your events with ease.
6049

6150
<img alt="Hi.Events self-hosted ticket selling dashboard" src="https://hievents-public.s3.us-west-1.amazonaws.com/website/github-readme-screenshot.png"/>
51+
<div align="center">
6252
<caption>Generated using <a href="https://screenshot.rocks?utm_source=hi.events-readme">Screenshot Rocks</a></caption>
53+
</div>
6354

64-
## 🌟 Features
65-
66-
<a href="https://hi.events">Hi.Events</a> is packed with features to streamline your event management and ticketing:
67-
68-
### 🎟 Ticketing & Product Sales
69-
- **Multiple Ticket Types:** Free, Paid, Donation, and Tiered tickets.
70-
- **Capacity Management:** Set event-wide or ticket-specific limits.
71-
- **Capacity Assignments:** Manage shared capacity across multiple ticket types.
72-
- **Promo Codes:** Discount codes for pre-sale access and special offers.
73-
- **Product Sales:** Sell event-related products (e.g., t-shirts, add-ons).
74-
- **Taxes & Fees:** Apply custom taxes and fees per product or order.
75-
76-
### 🏆 Event Management & Customization
77-
- **Event Dashboard:** Real-time revenue, ticket sales, and attendee analytics.
78-
- **Homepage Designer:** Customize event pages with a live preview editor.
79-
- **Embeddable Ticket Widget:** Add a seamless ticketing experience to your website.
80-
- **SEO Tools:** Customize event metadata for better search visibility.
81-
- **Product Categories:** Organize products and tickets with category management.
82-
- **Offline Event Support:** Provide instructions for physical events.
83-
84-
### 📧 Attendee & Order Management
85-
- **Custom Checkout Forms:** Collect attendee details with tailored questions.
86-
- **Attendee Management:** Search, edit, cancel, and message attendees.
87-
- **Order Management:** Refund, cancel, and resend order details easily.
88-
- **Bulk Messaging:** Email or message specific ticket holders.
89-
- **Data Exports:** Export attendees and orders to CSV/XLSX.
90-
91-
### 📱 Mobile-Friendly & Check-In Tools
92-
- **QR Code Check-In:** Web-based and mobile-friendly check-in tool.
93-
- **Check-In Lists:** Generate and share access-controlled check-in lists.
94-
- **Multi-User Access:** Role-based access control for event staff.
95-
96-
### 🔧 Integrations & Automation
97-
- **Webhooks Support:** Automate tasks with Zapier, IFTTT, Make, or CRM integrations.
98-
- **Stripe Connect Integration:** Organizers get instant payouts.
99-
100-
### 📊 Advanced Features
101-
- **Multi-Language Support:** English, Deutsch, Español, Português, Français, 中文 (Zhōngwén), and more.
102-
- **Partial & Full Refunds:** Manage refunds with detailed order tracking.
103-
- **Role-Based Access Control:** Multiple user roles with permission management.
104-
- **REST API:** Full API access for custom integrations.
105-
- **Invoicing System:** Generate and send invoices with tax details, payment terms, and due dates.
106-
- **Offline Payment Support:** Enable bank transfers, cash payments, or custom payment methods.
107-
- **Event Archive:** Archive past events to keep the dashboard organized.
108-
- **Advanced Ticket Locking:** Lock tickets behind promo codes or access restrictions.
109-
- **Advanced Reporting:** Daily sales, tax breakdowns, product sales, and promo code usage reports.
110-
111-
## 🚀 Getting Started
112-
113-
For detailed installation instructions, please refer to our [documentation](https://hi.events/docs/getting-started). For
114-
a quick start, follow these steps:
55+
## ⚡ Quick Deploy
11556

116-
### One-Click Deployments
57+
Get started in minutes with our one-click deployment options:
11758

11859
[![Deploy on DigitalOcean](https://www.deploytodo.com/do-btn-blue.svg)](https://github.com/HiEventsDev/hi.events-digitalocean)
119-
12060
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://github.com/HiEventsDev/hi.events-render.com)
121-
12261
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/8CGKmu?referralCode=KvSr11)
123-
12462
[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/8DIRY6)
12563

64+
## 🌟 Key Features
65+
66+
<a href="https://hi.events">Hi.Events</a> offers comprehensive tools to streamline your event management:
67+
68+
### 🎟 Ticketing & Sales
69+
- **Multiple Ticket Types:** Create free, paid, donation-based, and tiered tickets
70+
- **Capacity Management:** Set limits per event or ticket type
71+
- **Promo Codes & Discounts:** Drive early sales with special offers
72+
- **Product Upsells:** Sell merchandise and add-ons alongside tickets
73+
- **Custom Pricing:** Apply taxes and fees per product or entire order
74+
75+
### 🏆 Event Management
76+
- **Real-time Dashboard:** Track sales, revenue, and attendee metrics
77+
- **Visual Page Editor:** Design beautiful event pages with live preview
78+
- **Website Integration:** Embed ticketing widgets on your existing site
79+
- **SEO Optimization:** Customize metadata for better search visibility
80+
- **Offline Event Support:** Provide location details and instructions
81+
82+
### 📱 Attendee Experience
83+
- **Custom Registration Forms:** Collect exactly the information you need
84+
- **QR Code Check-In:** Fast, mobile-friendly entry verification
85+
- **Multi-language Support:** Reach global audiences with localized interfaces
86+
- **Bulk Communication:** Send targeted messages to specific ticket holders
87+
- **Refund Management:** Process full or partial refunds when needed
88+
89+
### 🔧 For Organizers
90+
- **Team Collaboration:** Role-based access for staff members
91+
- **Webhook Integration:** Connect with Zapier, IFTTT, Make, or your CRM
92+
- **Stripe Connect:** Receive instant payouts for ticket sales
93+
- **Comprehensive API:** Build custom integrations with full API access
94+
- **Advanced Reporting:** Generate sales, tax, and usage reports
95+
96+
## 🚀 Getting Started
97+
12698
### 🐳 Quick Start with Docker
12799

128100
> [!IMPORTANT]
@@ -148,7 +120,7 @@ a quick start, follow these steps:
148120
echo base64:$(openssl rand -base64 32) # For APP_KEY
149121
openssl rand -base64 32 # For JWT_SECRET
150122
```
151-
123+
152124
**Windows:**
153125
Check the instructions in *./docker/all-in-one/README.md* for generating the keys on Windows.
154126

@@ -159,48 +131,36 @@ a quick start, follow these steps:
159131
docker compose up -d
160132
```
161133
5. **Create an account:**
162-
```bash
163-
Open your browser and navigate to http://localhost:8123/auth/register.
134+
```
135+
Open your browser and navigate to http://localhost:8123/auth/register
164136
```
165137

166-
ℹ️ Please refer to the [getting started guide](https://hi.events/docs/getting-started) for other installation methods, and
167-
for setting up a production or local development environment.
138+
ℹ️ For detailed setup instructions including production deployment, please refer to our [getting started guide](https://hi.events/docs/getting-started).
168139

169140
## 💜 Sponsors
170-
<a href="https://stinkingbadges.app/?utm_source=hi.events-readme">
171-
Stinking Badges
172-
</a>
173141

174-
### Making a Donation
142+
### Support the Project
175143

176-
If you find Hi.Events useful, it would be massively appreciated if you made a small donation to help support the project.
144+
If you find Hi.Events valuable for your organization, please consider supporting ongoing development:
177145

178-
We'll use your donation to fund ongoing development and maintenance of Hi.Events.
146+
<a href="https://www.buymeacoffee.com/hi.events" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;"></a>
179147

180-
<a href="https://www.buymeacoffee.com/hi.events" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
181-
<br/>
182-
or
183-
<a href="https://github.com/sponsors/HiEventsDev" target="_blank"> Sponsor on GitHub</a>
184-
or
185-
<a href="https://opencollective.com/hievents" target="_blank"> Sponsor on Open Collective</a>
148+
Or support us on: <a href="https://github.com/sponsors/HiEventsDev" target="_blank">GitHub Sponsors</a> | <a href="https://opencollective.com/hievents" target="_blank">Open Collective</a>
186149

187150
## 📝 Change Log
188151

189-
Stay updated with our ongoing improvements and feature additions at
190-
our [GitHub releases page](https://github.com/HiEventsDev/hi.events/releases).
152+
Stay updated with our latest features and improvements on our [GitHub releases page](https://github.com/HiEventsDev/hi.events/releases).
191153

192154
## 🤝 Contributing
193155

194-
We welcome contributions, suggestions, and bug reports! Please see our [contributing guidelines](CONTRIBUTING.md) for more
195-
information.
156+
We welcome contributions from the community! Please see our [contributing guidelines](CONTRIBUTING.md) for details on how to get involved.
196157

197158
## ❓ FAQ
198159

199-
Have questions? Our [Docs](https://hi.events/docs) have answers. If you can't find what you're looking for, feel free to
200-
reach out to us at [[email protected]](mailto:[email protected]).
160+
Have questions? Our [documentation](https://hi.events/docs?utm_source=gh-readme&utm_content=faq-docs-link) has answers. For additional support, contact us at [[email protected]](mailto:[email protected]).
201161

202162
## 📜 License
203163

204-
Hi.Events is licensed under the terms of the [AGPL-3.0](https://github.com/HiEventsDev/hi.events/blob/main/LICENCE) license.
164+
Hi.Events is licensed under the [AGPL-3.0](https://github.com/HiEventsDev/hi.events/blob/main/LICENCE) license.
205165

206166
For more licensing information, including commercial licencing options, please visit our licensing page [here](https://hi.events/licensing).

0 commit comments

Comments
 (0)