Skip to content

Commit 0429c7e

Browse files
authored
docs: updated README
1 parent 5457af1 commit 0429c7e

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
# evsy
1+
# Evsy
22
Evsy is a lightweight admin panel for managing and documenting product analytics events and their properties.
33

44
(!) Evsy is currently in active development. Expect rapid improvements and frequent updates!
55

66
## ✨ About
7-
Evsy is an open-source application for managing analytics events —
8-
including event descriptions, their attributes (fields), and tags.
7+
Evsy is an open-source application for managing analytics events — including event descriptions, their attributes (fields), and tags.
98

10-
It helps product teams, analysts, and developers structure and document all key events in a convenient, extensible way.
9+
It helps product teams, analysts, and developers structure and document their events in a convenient, extensible way.
1110

1211
## 📚 Features
13-
- Manage events: create, update, delete, tag them.
14-
- Manage fields: document event attributes.
15-
- Manage tags: group related events together.
16-
- Dark/light theme switcher.
12+
- Create and document events and fields.
13+
- Organize them by type, tag, or team.
14+
- Export events to Swagger schemas.
15+
- Sign up via email/password or OAuth2 (GitHub & Google)
1716

1817
**Future roadmap includes:**
19-
- Field examples;
20-
- Audit log (history of changes);
21-
- Session and user management;
22-
- Teams and organizations support;
23-
- SaaS hosting.
18+
- Roles and user management;
19+
- Audit log (history of changes) and event versioning;
20+
- Full-text search;
21+
- Additional event states (`draft`, `archived`);
22+
- Markdown descriptions;
23+
- Grafana integration;
24+
- ... and more!
2425

2526
## 🚀 Quick Start
2627
To run Evsy via Docker compose, do:
@@ -55,7 +56,7 @@ evsy/
5556
```
5657

5758
## 🤝 Contributing
58-
We welcome all kinds of contributions — from code to ideas, design suggestions, and bug reports.
59+
We welcome all kinds of contributions — code, ideas, design suggestions, and bug reports.
5960
[Read the contributing guide →](CONTRIBUTING.md)
6061

6162
## Build Status

0 commit comments

Comments
 (0)