diff --git a/readme.md b/readme.md index 60c2c6e..e3ee1c4 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,9 @@ ![hellgate logo](mandatory-js-project-logo.png) -a complete web-to-gemini proxy +---- -## requirements +A complete web-to-gemini proxy + +## Requirements - nodejs - npm - electron @@ -11,7 +13,7 @@ a complete web-to-gemini proxy - libgconf-2-4 - xvfb (if you're running it headless) -## setup +## Setup - `sudo apt install libgtk2.0-0 libgconf-2-4` (if you're on debian, other distros idk) - `sudo apt install xvfb` (again, on debian) @@ -23,18 +25,18 @@ a complete web-to-gemini proxy - `npm start` or `xvfb-run npm start` - the server will listen on localhost -## what is this? +## What is this? - hellgate is a web browser with a gemini server attached - ask the server for a webpage and it will access it, render it, and send it to you in gemtext format -## why not just use `curl` and convert the html to gemtext? +## Why not just use `curl` and convert the html to gemtext? - because hellgate runs a fully featured web browser, it has the ability to execute javascript like a browser would - this means websites that require javascript to function (like say, cnn.com) can be made accessible over gemini -## what is the `sigils` dir for? +## What is the `sigils` dir for? - hellgate is extensible through the use of files called 'sigils' - a sigil is a file containing user-created javascript that will execute inside the browser sandbox whenever its corresponding page is accessed @@ -47,6 +49,6 @@ javascript environment - if you write a new sigil for a specific website, don't hesitate to send it as a pull request to this repo -## notes +## Notes - as of right now the npm version of gemini-server is broken, use the version from github or this will not work