Skip to content

Commit f3798a7

Browse files
committed
Create README.md
1 parent 50e450f commit f3798a7

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Headless
2+
---
3+
Headless is an API to deliver nodes and lists of nodes as JSON data.
4+
5+
This allows you to publish content to you Backdrop site and send it out to other applications. For example you could have an
6+
Apache Cordovo app that polls for the latest news posts on your site and renders them as a native iOS or Android app to users'
7+
mobile phones.
8+
9+
* Exposes individual nodes as JSON data to be consumed by another application.
10+
* Once the `headless` module is installed visiting a URL using this form: http://mysite.com/api/page/16 will expose that node as a JSON object.
11+
* You can replace `page` with any content type on your site
12+
* You replace `16` with the node id (`nid`) of the content that you want to recieve as JSON data.
13+
* Expose lists of nodes as JSON data.
14+
* Visit a URL using this form: http://mysite.com/api/list/post
15+
16+
License
17+
-------
18+
19+
This project is GPL v2 software. See the LICENSE.txt file in this directory for
20+
complete text.
21+
22+
Maintainers
23+
-----------
24+
25+
- Geoff St. Pierre (https://github.com/serundeputy/)

0 commit comments

Comments
 (0)