Skip to content

Commit f5631ef

Browse files
committed
Update readme
1 parent bb2beb9 commit f5631ef

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
1-
### WooCommerce Memberships REST API documentation
1+
# WooCommerce Memberships REST API documentation
2+
3+
Official repository for the documentation of the [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/) REST API.
4+
5+
If you are looking for the general plugin documentation, [please follow this link](https://docs.woocommerce.com/document/woocommerce-memberships/).
6+
7+
### Contributing
8+
9+
You can contribute to this documentation by:
10+
11+
* [Opening an issue](https://github.com/skyverge/woocommerce-memberships-rest-api-docs/issues/new) to report a problem or an information missing, etc.
12+
* Opening a pull request to extend the documentation.
13+
14+
Please **do not submit feature requests for the REST API** here. You can use the [WooIdeas board](http://ideas.woocommerce.com/forums/133476-woocommerce?category_id=125014) or [Contact SkyVerge support](https://www.skyverge.com/support/) for that.
15+
16+
### Updating pages
17+
18+
This project uses [Slate](https://github.com/lord/slate) for building the documentation pages.
19+
20+
Follow [Slate readme](https://github.com/lord/slate/blob/master/README.md) and [wiki](https://github.com/lord/slate/wiki) for instructions on how to edit files and make changes.
21+
22+
### Deploying an update
23+
24+
To install locally use:
25+
26+
```shell
27+
bundle install
28+
```
29+
30+
> **Important note:** if you run into `bundle install` errors, you may need to install `ruby-devel` and install the related gems again to build native extensions.
31+
32+
Then, to test changes locally run:
33+
34+
```shell
35+
bundle exec middleman server
36+
```
37+
38+
Finally, after pushing changes and you are ready to deploy use the script:
39+
40+
```shell
41+
bash deploy.sh
42+
```
43+
44+
45+

source/index.html.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ language_tabs: # must be one of https://git.io/vQNgJ
77

88
toc_footers:
99
- <a href='https://woocommerce.com/products/woocommerce-memberships/'>Get WooCommerce Memberships</a>
10-
- <a href='https://docs.woocommerce.com/document/woocommerce-memberships/'>WooCommerce Memberships Documentation</a>
10+
- <a href='https://docs.woocommerce.com/document/woocommerce-memberships/'>Plugin Documentation</a>
1111

1212
includes:
1313
- errors

0 commit comments

Comments
 (0)