From 2dbca4d398397233be6adf7b1671c25d219d4a84 Mon Sep 17 00:00:00 2001 From: shagi Date: Tue, 24 Sep 2024 14:05:03 +0200 Subject: [PATCH] chore: update readme --- readme.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index a4a06d3..6ea18aa 100644 --- a/readme.md +++ b/readme.md @@ -1,23 +1,30 @@ Negro Mate static generator =========================== -This module provides extra commands to negromate: +This module provides extra commands to negromate. -build ------ + +negromate build +--------------- Static web generator. Updates songs folder with required html files and static content. -run ---- +negromate run +------------- Starts a local web server to try current version. -rsync ------ +negromate rsync +--------------- Syncronizes web with a remote folder, ready to be served with any web server. -ipfs ----- +Needs the following packages installed: + + * rsync + +negromate ipfs +-------------- Adds web to local ipfs node and pins remote server, unpinning previous version. + +Needs a working local ipfs node. Seek information at https://ipfs.tech/