Skip to content

Commit

Permalink
Update README and update url
Browse files Browse the repository at this point in the history
  • Loading branch information
awaluk committed Sep 5, 2017
1 parent d482f8a commit ed95d0e
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 8 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# q2a-api
Simple API serving data from Q2A in JSON
# API plugin to [Question2Answer](http://question2answer.org/)

Simple API plugin to serving data from Q2A script in JSON.

## Installation

Clone or download this repository to *qa-plugin* directory in your Q2A.

## Available functions

- **/api/favorites** - getting favorites for logged user: users, questions, tags and categories


---

**Important notice about code!**
This code don't respect PHP PSR-2 standard, because Question2Answer unfortunately too don't respect this. Also, I couldn't design classes and functions in my own way, because most of them impose Question2Answer script.
6 changes: 3 additions & 3 deletions metadata.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "Q2A API",
"uri": "",
"uri": "https://github.com/awaluk/q2a-api",
"description": "Simple API serving data from Q2A in JSON",
"version": "1.0",
"version": "0.1",
"date": "2017-09-01",
"author": "Arkadiusz Waluk",
"author_uri": "http://waluk.pl",
"license": "MIT",
"min_q2a": "1.5",
"update_uri": ""
"update_uri": "https://raw.githubusercontent.com/awaluk/q2a-api/master/metadata.json"
}
6 changes: 3 additions & 3 deletions qa-plugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

/*
Plugin Name: Q2A API
Plugin URI:
Plugin URI: https://github.com/awaluk/q2a-api
Plugin Description: Simple API serving data from Q2A in JSON
Plugin Version: 1.0
Plugin Version: 0.1
Plugin Date: 2017-09-01
Plugin Author: Arkadiusz Waluk
Plugin Author URI: https://waluk.pl
Plugin License: MIT
Plugin Minimum Question2Answer Version: 1.5
Plugin Update Check URI:
Plugin Update Check URI: https://raw.githubusercontent.com/awaluk/q2a-api/master/metadata.json
*/

if (!defined('QA_VERSION')) {
Expand Down

0 comments on commit ed95d0e

Please sign in to comment.