From 5ec3fd527f24aef06a8a9bf71df07fb8426d63ec Mon Sep 17 00:00:00 2001 From: KIMMYSJ <38124097+KIMMYSJ@users.noreply.github.com> Date: Wed, 7 Nov 2018 12:50:16 +0900 Subject: [PATCH] fixed some errors in readme.md Fix or removed some words to make sentences concise! --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a26fd48..2b49d0f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # rePress -WordPress will soon release a [REST API](http://wp-api.org/#rest-api_about) as a core feature. The code is currently available as [a plugin](https://github.com/WP-API/WP-API) so that WP contributors can iterate on it with real users without throwing it immediately into the codebase. (WordPress calls it a "Feature Plugin.") This is a Jekyll Plugin that will ingest data from a WordPress API and export Jekyll posts at the time the site is built. You can have the WordPress site running anywhere you want, even on a local web server. All you need to do is install the plugin, for now, and know where the API endpoint is (usually `wp-json`). +WordPress will soon release a [REST API](http://wp-api.org/#rest-api_about) as a core feature. The code is currently available as [a plugin](https://github.com/WP-API/WP-API) so that WP contributors can iterate on it with users without throwing it immediately into the codebase. (WordPress calls it a "Feature Plugin.") Jekyll Plugin will ingest data from a WordPress API and export Jekyll posts when the site is built. With Jekyll Plugin, the WordPress site runs even on a local web server. +What you need to do is: +-install the plugin. +-find a location of API endpoint (usually stored as 'wp-json'). The ultimate goal is a Jekyll installation where you can write posts in either the WordPress content editor or as Markdown files served on a Jekyll-built site. @@ -12,4 +15,4 @@ The ultimate goal is a Jekyll installation where you can write posts in either t ## Support -The plugin currently supports ingesting posts and exporting the raw post content. And currently has some characters like pipes showing up in strange places. But, hey, we're just getting started! This is very much a work in progress and contributions and bits of advice are welcome. +The plugin now supports ingesting posts and exporting the raw post content. The plugin has some problems such as pipes showing up in strange places. Please aware that we are just started and the work is in progress. Feedback is welcome!