Skip to content

Commit e2b2c91

Browse files
committed
Adds wordpress readme, changelog, update gitignore
1 parent d89cc0f commit e2b2c91

File tree

4 files changed

+61
-1
lines changed

4 files changed

+61
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ wp-content/plugins/hello.php
1919
.DS_Store
2020
node_modules
2121
better-rest-endpoints.zip
22+
better-rest-endpoints/

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
n/a
9+
10+
## [1.0.1] - 2018-01-19
11+
### Added
12+
- Changelog
13+
- readme.txt for WP repo

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# better-rest-endpoints
2-
A WordPress plugin that serves up slimmer WP Rest API endpoints - WIP
2+
A WordPress plugin that serves up slimmer WP Rest API endpoints.
33

44
## Endpoints
55

readme.txt

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
=== Better Rest Endpoints ===
3+
Author URI: https://factor1studios.com
4+
Plugin URI: https://github.com/factor1/better-rest-endpoints
5+
Contributors: factor1, erwstout
6+
Tags: rest, api, endpoints, acf, json
7+
Requires at least: 4.7.1
8+
Tested up to: 4.9.2
9+
Stable Tag: 2.8.17
10+
License: GNU Version 3 or Any Later Version
11+
12+
A WordPress plugin that serves up slimmer WP Rest API endpoints.
13+
14+
== Description ==
15+
16+
A WordPress plugin that serves up slimmer WP Rest API endpoints, with some great
17+
enhancements like ACF fields, WordPress menu endpoints, and more. You can
18+
view the full documentation and features [here](https://github.com/factor1/better-rest-endpoints).
19+
20+
== Installation ==
21+
22+
1. Activate the plugin
23+
2. Use the better-rest-endpoint API endpoint to access your data
24+
25+
== Frequently Asked Questions ==
26+
27+
= Where can I find all the documentation? =
28+
29+
You can find the complete documentation on [GitHub](https://github.com/factor1/better-rest-endpoints).
30+
31+
= Why make this plugin? =
32+
33+
The core Rest API is full of information we don't really need in our responses.
34+
This was a solution to serve up exactly what we need for making beautiful sites
35+
with great speeds.
36+
37+
= Do I just turn this on and it works? =
38+
39+
It's worth noting that Better Rest Endpoints is for the more seasoned theme or app developer.
40+
Just activating the plugin will do nothing - you need to build/adjust your theme or
41+
apps endpoints to use Better Rest Endpoints.
42+
43+
== Changelog ==
44+
45+
= 1.0.1, January 1, 2018 =
46+
* Prep: Update files for release on WP Repo.

0 commit comments

Comments
 (0)