Starting getting the README together for the beta

This commit is contained in:
Ro 2020-07-01 14:40:03 -07:00
parent 53da617ee4
commit 9a14d6cf5c

View file

@ -1,7 +1,12 @@
# Fipamo
![This is Fipamo](https://playvicio.us/base-assets/images/fipamo-brand.png)
# Fipamo means to save
Fipamo is a super chill, no database blogging platform. It renders flat html, js and css so you can host your site anywhere without a whole bunch of complicated settings to get it up and running.
The Fipamo project was born from a need for a simple, easy to use no data blog platform that doesn't require much effort to set up and maintain. Fipamo uses Markdown to handle posts and renders them to flat html so you can serve them from anywhere. No complicated set ups. No long list of dependecies. Just write and publish.
Because nobody has time for all that.
The Beta is almost here
## So here's what you need to use Fipamo
You'll need at least `Node 10.16.0` and `PM2` is you want to use Fipamo to serve your html, css and js files. If you want to contribute to the project, you're gonna need `nodemon` for you dev environment.
Once you have all of that taken care of, run `npm install` and go to `https://yourdomain/@/dashboard` start your set up. Yup. That's it.