From 00005f95ac50f6bbed5b0184c1d75986aa215274 Mon Sep 17 00:00:00 2001 From: memdmp Date: Tue, 27 May 2025 22:59:21 +0200 Subject: feat: more readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2e0b00f..3db97c3 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,22 @@ [![readme title image](https://web.archive.org/web/20250107095158if_/https://files.catbox.moe/sg16ei.png)](https://design.penpot.app/#/view/7b8778b5-b939-80fe-8005-8b3dbcbe8096?page-id=7b8778b5-b939-80fe-8005-8b3dbcbe8097§ion=interactions&index=0&share-id=d7727c3e-6ff4-8175-8005-95c838013584) +
+ +[![Please don't upload this repository to GitHub](https://nogithub.codeberg.page/badge.svg "A crossed out Github Octocat with text saying 'No Github' next to it.")](https://nogithub.codeberg.page) + # zuwu.zsh — usable defaults for zsh -zuwu.zsh (zuwu) is a highly opinionated zsh "plugin"/"microframework" that provides sensible defaults for keybindings and completions, aswell as attempting to load a few plugins, as to make `sudo apk add zsh zsh-fast-syntax-highlighting zsh-autosuggestions` (note: these are optional, they're just recommended) followed by installing zuwu be sufficient for an enjoyable shell experience. +zuwu.zsh (zuwu) is a highly opinionated zsh "plugin"/"microframework" that provides sensible defaults for keybindings and completions. + +
+ +## the idea + +The idea is to provide a "zsh if it was setup sensibly by default and **just worked**" experience.
+This means no [thousands of builtins](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins) in the framework ([or just your PROMPT](https://starship.rs/config/)), and no [automatic updates](https://github.com/ohmyzsh/ohmyzsh/wiki/Settings#update-settings). + +This also means it's [easy to package](https://git.estrogen.zone/alpine-packages.git/tree/src/memdmp/zsh-zuwu/APKBUILD), and [easy to audit](./zuwu.zsh) (or fork and maintain yourself if you're not happy) ## installation -- cgit v1.2.3