Skip to content

Commit 127c445

Browse files
Version 0.0.1
1 parent d80a225 commit 127c445

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [0.0.1] - 2019-06-25
8+
### Added
9+
- Initial version.
10+
11+
[Unreleased]: https://github.com/woocommerce/woocommerce-api-docs/compare/0.0.1...HEAD
12+
[0.0.1]: https://github.com/woocommerce/woocommerce-api-docs/compare/749f431...0.0.1

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# woocommerce-api-docs
2-
WooCommerce Class API Docs
1+
# WooCommerce Class API Docs
2+
3+
Generate WooCommerce [Class API Docs](https://docs.woocommerce.com/wc-apidocs/index.html).
4+
5+
## Install
6+
7+
```bash
8+
git clone https://github.com/woocommerce/woocommerce-api-docs.git
9+
```
10+
11+
## Usage
12+
13+
```bash
14+
cd woocommerce-api-docs
15+
./generate.sh -w <woocommerce_version>
16+
```
17+
18+
### Options
19+
20+
| Options | Description |
21+
|-------------------------|-------------------------|
22+
| `-h` or `--help` | Shows help message |
23+
| `-v` or `--version` | Shows generator version |
24+
| `-w` or `--woocommerce` | WooCommerce version |
25+
26+
## Changelog
27+
28+
[See changelog for details](https://github.com/woocommerce/woocommerce-api-docs/blob/master/CHANGELOG.md)

0 commit comments

Comments
 (0)