Skip to content

Commit 5e424c0

Browse files
committed
feat(add): changelog
1 parent edde579 commit 5e424c0

File tree

2 files changed

+118
-7
lines changed

2 files changed

+118
-7
lines changed

CHANGELOG.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Planned
11+
- API documentation
12+
- Mobile app
13+
- Custom domain support
14+
- Advanced analytics dashboard
15+
- Bulk link import/export
16+
- Link scheduling
17+
18+
## [0.1.0] - 2024-01-15
19+
20+
### 🎉 Initial Release
21+
22+
#### Added
23+
- **Core Features**
24+
- User authentication via Google, GitHub, and Discord OAuth
25+
- Custom handle/username system
26+
- Link management with drag & drop reordering
27+
- Section organization for grouping links
28+
- Real-time link analytics (views, clicks)
29+
- Profile customization (bio, profile image)
30+
31+
- **Theming & Customization**
32+
- Multiple built-in themes (Minimal, Modern, Gradient, Neon, etc.)
33+
- Custom color schemes
34+
- Background pattern options
35+
- Typography customization
36+
- Mobile-responsive design
37+
38+
- **User Experience**
39+
- Intuitive admin dashboard
40+
- Real-time preview of changes
41+
- Drag & drop link management
42+
- Section-based organization
43+
- Link archiving functionality
44+
45+
- **Privacy & Security**
46+
- GDPR compliance
47+
- Complete data export functionality
48+
- Account deletion with data cleanup
49+
- Privacy-first approach
50+
- No data selling policy
51+
52+
- **Technical Features**
53+
- Server-side rendering with Next.js 13
54+
- PostgreSQL database with Prisma ORM
55+
- Responsive design with Tailwind CSS
56+
- Component library with Radix UI
57+
- Smooth animations with Framer Motion
58+
59+
- **Pages & Layout**
60+
- Landing page with feature showcase
61+
- User profile pages
62+
- Admin dashboard
63+
- Settings panel
64+
- Legal pages (Privacy, Terms, GDPR, Cookies)
65+
- About and Contact pages
66+
- Press kit with downloadable assets
67+
68+
- **Developer Experience**
69+
- Open source under AGPL 3 license
70+
- Comprehensive documentation
71+
- ESLint and Prettier configuration
72+
- TypeScript-ready codebase
73+
- Docker support
74+
75+
#### Technical Stack
76+
- **Frontend:** Next.js 13, React 18, Tailwind CSS
77+
- **Backend:** Next.js API routes, Prisma ORM
78+
- **Database:** PostgreSQL
79+
- **Authentication:** NextAuth.js with OAuth providers
80+
- **UI Components:** Radix UI primitives
81+
- **Animations:** Framer Motion
82+
- **State Management:** Zustand
83+
- **Deployment:** Vercel
84+
85+
#### Security
86+
- OAuth-based authentication (no password storage)
87+
- CSRF protection
88+
- Secure session management
89+
- Data encryption in transit
90+
- Regular security updates
91+
92+
---
93+
94+
## Release Notes
95+
96+
### 🎯 What's Next?
97+
- Enhanced analytics with detailed metrics
98+
- Custom domain support for pro users
99+
- API access for developers
100+
- Mobile application
101+
- Advanced customization options
102+
103+
### 🐛 Known Issues
104+
- None at this time
105+
106+
### 🤝 Contributing
107+
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
108+
109+
### 📞 Support
110+
- 🐛 [Report bugs](https://github.com/LynkrApp/Website/issues)
111+
- 💡 [Request features](https://github.com/LynkrApp/Website/issues)
112+
- 💬 [Join our Discord](https://discord.gg/g76w2v7RzG)
113+
- 📧 [Email us](mailto:hello@lynkr.link)
114+
115+
---
116+
117+
**Full Changelog**: https://github.com/LynkrApp/Website/commits/v0.1.0

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,6 @@
3030
- 🎯 **Drag & Drop** - Intuitive interface for managing links
3131
- 📤 **Data Export** - Download your data anytime in JSON format
3232

33-
## 🚀 Demo
34-
35-
<div align="center">
36-
<img src="public/assets/new_shot.png" alt="Lynkr Dashboard" width="800">
37-
</div>
38-
3933
## 🛠️ Tech Stack
4034

4135
- **Framework:** [Next.js 13](https://nextjs.org/)
@@ -191,7 +185,7 @@ We welcome feature requests! Please:
191185

192186
## 📄 License
193187

194-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
188+
This project is licensed under the AGPL 3 License - see the [LICENSE](LICENSE) file for details.
195189

196190
## 🙏 Acknowledgments
197191

0 commit comments

Comments
 (0)