Skip to content

Commit bdbd38a

Browse files
authored
Merge pull request #10 from Rowayda-Khayri/fixes
Fix typos
2 parents 2abbb01 + 9ad8195 commit bdbd38a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ Wordpress Multisite JSON API
33
============================
44
This is a Wordpress Plugin that adds JSON endpoints for creating, listing, and deleting sites on multisite.
55

6-
This plugin aims to be simple to make Wordpress polyglot environments not only possible, but practical. I'm not the best at PHP, ruby and Go are more my thing, hence why I'm making this API. Contributions are greatly appreciated.
6+
This plugin aims to be simple to make Wordpress polyglot environments not only possible, but practical. I'm not the best at PHP, Ruby and Go are more my thing, hence why I'm making this API. Contributions are greatly appreciated.
77

88
Status
99
------
10-
* **TODO**: Add some configuration options
11-
* **TODO**: Add `full-stack-test.php` to make a MySQL connection and verify the whole stack loads, faster and more efficient than trying to do a full page rendering for your uptime checks.
10+
* **TODO**: Add some configuration options.
11+
* **TODO**: Add `full-stack-test.php` to make a MySQL connection and verify the whole stack loads faster and more efficient than trying to do a full page rendering for your uptime checks.
1212

1313
PHP Versions
1414
------------
15-
This is theoretically compatible with PHP 5.4 and higher. However, upgrading to phpunit 8 required that I make tests require PHP 7.2+. So its probably still fine to run this on something less than 7.2, but since I can't get working tests on that version, I don't recommend it.
15+
This is theoretically compatible with PHP 5.4 and higher. However, upgrading to phpunit 8 required that I make tests require PHP 7.2+. So, it's probably still fine to run this on something less than 7.2, but since I can't get working tests on that version, I don't recommend it.
1616

1717
Security
1818
--------
@@ -38,7 +38,7 @@ location /wp-content/plugins/multisite-json-api/endpoints {
3838
}
3939
```
4040

41-
Also, as of right now all user names and password are passed through http Headers. That means SSL is pretty much mandatory.
41+
Also, as of right now all user names and passwords are passed through HTTP headers. That means SSL is pretty much mandatory.
4242

4343
API Documentation
4444
=================
@@ -47,14 +47,14 @@ Authentication
4747
--------------
4848
All of the enpoints require you to authenticate with an existing wordpress user. Currently all require the superadmin role, but that may change.
4949

50-
Username and password are passed with the HTTP Headers `User` and `Password` respectively. These are plain text so you need to be using SSL (which you are doing already right?).
50+
Username and password are passed with the HTTP headers `User` and `Password` respectively. These are plain text so you need to be using SSL (which you are doing already right?).
5151

5252
Create Site
5353
-----------
5454
- **URL:** /wp-content/plugins/multisite-json-api/endpoints/create-site.php
5555
- **Method:** POST
5656
- **Payload example:** `{"email": "user@example.com", "site_name": "awesomeblog", "title": "Awesome Blog", "password":"123456"}`
57-
- **Description:** Creates a site. If the email address does not exist this will create a new user with that email address. The `site_name` is the path or subdomain you would like to use, password os optional, if not set will fallback to a random generated one.
57+
- **Description:** Creates a site. If the email address does not exist this will create a new user with that email address. The `site_name` is the path or subdomain you would like to use, password is optional, if not set will fallback to a random generated one.
5858

5959
List Sites
6060
----------
@@ -69,7 +69,7 @@ Delete Site
6969
- **URL:** /wp-content/plugins/multisite-json-api/endpoints/delete-site.php
7070
- **Method:** DELETE
7171
- **Payload example:** `{"blog_id": 49, "drop": false}`
72-
- **Description:** Deletes a site. If `drop` is set to `true` wordpress will remove the site from the database completely. Otherwise the only thing this does is set the `deleted` attribute on the site to `true`.
72+
- **Description:** Deletes a site. If `drop` is set to `true`, wordpress will remove the site from the database completely. Otherwise, the only thing this does is to set the `deleted` attribute on the site to `true`.
7373

7474
Acknowledgements
7575
----------------

0 commit comments

Comments
 (0)