Skip to content

Commit aa8ed68

Browse files
committed
docs: add banner to README header
1 parent 14a541e commit aa8ed68

1 file changed

Lines changed: 2 additions & 84 deletions

File tree

README.md

Lines changed: 2 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<div align="center">
22

3+
![Notevo](docs/assets/banner.svg)
4+
35
<img src="public/logo.svg" alt="Notevo Logo" width="64" height="64" />
46

57
# Notevo
@@ -31,8 +33,6 @@
3133
| ⚙️ **CI/CD Setup** | `██████████` | ![100](https://img.shields.io/badge/100-brightgreen?style=flat-square) | 15% |
3234
| 🎯 **Issue Response** | `██████████` | ![100](https://img.shields.io/badge/100-brightgreen?style=flat-square) | 10% |
3335
|**Community Signal** | `█░░░░░░░░░` | ![10](https://img.shields.io/badge/10-red?style=flat-square) | 5% |
34-
35-
Improve the repository's documentation by addressing the low "docs" score, currently at 48, to enhance the overall health score of DevLens.
3636
<!-- DEVLENS:END -->
3737

3838
---
@@ -99,98 +99,16 @@ Open [http://localhost:3000](http://localhost:3000) — that's it.
9999

100100
---
101101

102-
## Database Setup
103-
104-
Migrations live in `supabase/migrations/`. Apply them via the Supabase CLI:
105-
106-
```bash
107-
npx supabase db push
108-
```
109-
110-
Or copy the SQL from `supabase/migrations/` into the Supabase SQL editor manually.
111-
112-
---
113-
114102
## Deploy to Vercel
115103

116-
One-click deploy — the fastest way to get your own private Notevo instance:
117-
118104
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FSamoTech%2Fnotevo)
119105

120-
Set `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` in the Vercel environment variables panel during setup.
121-
122-
---
123-
124-
## Pages & Legal
125-
126-
Notevo ships with complete, production-ready legal and informational pages:
127-
128-
| Page | Route | Description |
129-
|---|---|---|
130-
| About | `/about` | What Notevo is and how it works |
131-
| Privacy Policy | `/privacy` | GDPR · CCPA · COPPA compliant — zero data collection |
132-
| Terms of Service | `/terms` | Free-forever commitment · MIT license · no warranty |
133-
| Cookie Policy | `/cookies` | No tracking cookies · localStorage only · PECR compliant |
134-
| Sponsor | `/sponsor` | Support the project — keep it free for everyone |
135-
136-
---
137-
138-
## ❤️ Sponsor
139-
140-
Notevo is free — and will stay free forever. But hosting, infra, and development take real time and money.
141-
142-
If Notevo saves you time or protects your privacy, consider supporting it:
143-
144-
**[github.com/sponsors/SamoTech](https://github.com/sponsors/SamoTech)**
145-
146-
| Tier | Amount | What it covers |
147-
|---|---|---|
148-
| ☕ Coffee | $3 one-time | Fuels a bug fix |
149-
| ❤️ Monthly | $5 / month | Hosting & infrastructure |
150-
| 🌟 Patron | $20 / month | Your name in the README |
151-
152-
Can't sponsor? **Star the repo** ⭐ and share it with someone who values privacy. It means a lot.
153-
154-
> Notevo will never show ads, sell your data, or add paywalls — no matter what. This is a promise.
155-
156-
---
157-
158-
## Contributing
159-
160-
PRs are welcome! Here's how to get started:
161-
162-
1. Fork the repo and create a feature branch: `git checkout -b feat/my-feature`
163-
2. Make your changes and test locally
164-
3. Run `npm run lint` and `npm run build` — both must pass
165-
4. Open a PR with a clear description of what changed and why
166-
167-
Issues labelled [`good first issue`](https://github.com/SamoTech/notevo/labels/good%20first%20issue) are a great starting point.
168-
169-
**Migrating from Laverna?** Open an issue — making that migration path seamless is a top priority.
170-
171-
See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
172-
173-
---
174-
175-
## Roadmap
176-
177-
- [ ] Mobile PWA (installable on iOS/Android)
178-
- [ ] Note sharing with expiring links
179-
- [ ] Folder / notebook hierarchy
180-
- [ ] Rich text (WYSIWYG) mode alongside Markdown
181-
- [ ] Self-hosted Docker image
182-
- [ ] Browser extension for quick capture
183-
184-
Have an idea? [Open an issue](https://github.com/SamoTech/notevo/issues/new) — community input shapes the roadmap.
185-
186106
---
187107

188108
## License
189109

190110
**MIT** — fork it, self-host it, build on it, own it.
191111

192-
See [LICENSE](LICENSE) for the full text.
193-
194112
---
195113

196114
<div align="center">

0 commit comments

Comments
 (0)