Skip to content

Commit

Permalink
Doing away with the REST, RESTUI, and Webcomponents dependencies. Upd…
Browse files Browse the repository at this point in the history
…ating README.md in light of recommended, near zero-config setup. HAX should now work with the default FULL HTML text format.
  • Loading branch information
mlsamuelson committed May 11, 2018
1 parent d6e5822 commit 9f255a8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ Download the REST UI module: https://www.drupal.org/project/restui
## Usage

This should give you the dependencies you need to get going.
1. Enable the HAX module and the dependencies it requires.
2. Visit the config page provided by REST UI and enable the "content" resource
with the "PATCH" method, the "json" request format and "cookie" auth. TODO AUTH ????
3. Go to the permissions page to ensure users have the 'use hax' permission
1. Enable the HAX module and any dependencies it requires.
2. Go to the permissions page to ensure users have the 'use hax' permission
checked. Once this is checked then people will start to see a 'HAX Authoring'
local menu item / tab / contextual option show up when they have access to
edit a node.
NOTE on Text Formats: HAX is designed to work with nodes with bodies in the
default Full HTML format where "Limit allowed HTML tags and correct faulty HTML"
is unchecked, or with formats with similarly permissive settings. For this
reason, it is advisable to only allow trusted users to access HAX.

## Settings

Expand Down
4 changes: 0 additions & 4 deletions hax.info.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
name: HAX
description: 'A completely Headless Authoring eXperience, #haxtheweb.'
core: 8.x
dependencies:
- rest
- restui
- webcomponents
type: module

0 comments on commit 9f255a8

Please sign in to comment.