chore: update readme

This commit is contained in:
Ales (Shagi) Zabala Alava 2024-09-24 14:05:03 +02:00
parent fe746acabe
commit 2dbca4d398
1 changed files with 16 additions and 9 deletions

View File

@ -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/