diff --git a/README.md b/README.md index 5ab25c3..5fd66e3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# jekyll-editor +# jekyll.js -jekyll addon that uses github personal access tokens to publish from website. +jekyll addon that uses github personal access tokens to publish from +website. ### Personal access tokens @@ -8,8 +9,14 @@ They can be generated from [here](https://github.com/settings/tokens). Remember ### Installation -You can simply add the git repo as a submodule in your jekyll post. Alternatively you can also use the editor at [georoot.github.io](georoot.github.io/jekyll-editor/). Because the `personal tokens` are only saved on local browser, make sure to logout if you are working on a not personal system. +You can simply add the git repo as a submodule in your jekyll post. +Alternatively you can also use the editor at [georoot.github.io](https://georoot.github.io/jekyll.js/). Because the `personal tokens` are only saved on local browser, make sure to logout if you are working on a not personal system. -### Note +To add as a submodule on existing jekyll blog -This is only the initial release for the system and there might be unseen bugs. \ No newline at end of file +``` +git submodule add https://github.com/georoot/jekyll.js admin +``` + +and then you can simply visit `.github.io/admin` to access +the editor. diff --git a/index.html b/index.html index ba27949..4cff295 100644 --- a/index.html +++ b/index.html @@ -31,7 +31,7 @@ - +