Merge pull request #2 from woocommerce/phpdoc

Phpdoc

Author: claudiosanches

.editorconfig

@@ -3,7 +3,7 @@ root = true
 
 [*]
 indent_style = space
-indent_size = 2
+indent_size = 4
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

.gitignore

@@ -1,3 +1,5 @@
+*.zip
 build/
-source/
+woocommerce/
 vendor/
+!data/templates/woocommerce/

CHANGELOG.md

@@ -4,9 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.0] - 2020-08-03
+### Added
+- PHPDoc 3.0 RC support.
+- New template
+### Remove
+- APIGen support.
+
 ## [0.0.1] - 2019-06-25
 ### Added
 - Initial version.
 
-[Unreleased]: https://github.com/woocommerce/woocommerce-api-docs/compare/0.0.1...HEAD
-[0.0.1]: https://github.com/woocommerce/woocommerce-api-docs/compare/749f431...0.0.1
+[Unreleased]: https://github.com/woocommerce/code-reference-generator/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/woocommerce/code-reference-generator/compare/0.0.1...0.1.0
+[0.0.1]: https://github.com/woocommerce/code-reference-generator/compare/749f431...0.0.1

README.md

@@ -1,32 +1,29 @@
-# WooCommerce Class API Docs
+# WooCommerce Code Reference Generator
 
-Generate WooCommerce [Class API Docs](https://docs.woocommerce.com/wc-apidocs/index.html).
+Generate [WooCommerce Code Reference](https://docs.woocommerce.com/wc-apidocs/index.html).
 
 ## Install
 
 ```bash
-git clone https://github.com/woocommerce/woocommerce-api-docs.git
+git clone https://github.com/woocommerce/code-reference-generator.git
 ```
 
 ## Usage
 
 ```bash
-cd woocommerce-api-docs
-./generate.sh -w <woocommerce_version>
+cd code-reference-generator
+./generate.sh -s <woocommerce_version>
 ```
 
 ### Options
 
-| Options                 | Description             |
-|-------------------------|-------------------------|
-| `-h` or `--help`        | Shows help message      |
-| `-v` or `--version`     | Shows generator version |
-| `-w` or `--woocommerce` | WooCommerce version     |
-
-## TODO
-
-- Find an alternative to ApiGen or fork ApiGen to fix support for latest PHP versions.
+| Options                    | Description                                                     |
+|----------------------------|-----------------------------------------------------------------|
+| `-h` or `--help`           | Shows help message                                              |
+| `-v` or `--version`        | Shows generator version                                         |
+| `-s` or `--source-version` | Version of the source code to release                           |
+| `-r` or `--github-repo`    | GitHub repo with username, default to "woocommerce/woocommerce" |
 
 ## Changelog
 
-[See changelog for details](https://github.com/woocommerce/woocommerce-api-docs/blob/master/CHANGELOG.md)
+[See changelog for details](https://github.com/woocommerce/code-reference-generator/blob/master/CHANGELOG.md)