Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
apjanco authored May 16, 2020
1 parent e8fac34 commit 3a9f109
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
🧿 Blini is a minimal site builder for essays and exhibits. When the application is running, users can add and edit content that is saved directly to html files in the `site` directory. The site is self-contained with no external dependencies. The site can be opened locally in the browser or deployed to Github pages, Netlify and other services.

in progress ...
For the moment, to try it out, clone this repository, create a Python 3 virtualenv, pip install requirements. You can change the site settings in [/site/site.yaml](https://github.com/apjanco/blini/blob/master/site/site.yaml). To run the application `uvicorn main:app --reload`. More documentation to come!

## Also note there is a `dev` variable in site.yaml When it's false, the site behaves like a published static site. When it's true, content can be added or edited.

0 comments on commit 3a9f109

Please sign in to comment.