Skip to content

Commit ae4349f

Browse files
toolstacktoolstack
committed
Regenerate readme.md
1 parent e5825c6 commit ae4349f

1 file changed

Lines changed: 83 additions & 27 deletions

File tree

‎readme.md‎

Lines changed: 83 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,83 @@
1-
# GP Auto Extract
2-
3-
A plugin for [GlotPress](https://wordpress.org/plugins/glotpress) that adds an option to extract original strings from a remote source repo directly in to a GlotPress project.
4-
5-
Features:
6-
7-
1. WordPress, GitHub and custom sources.
8-
2. Private GitHub repos with HTTP basic authentication.
9-
3. GitHub tags and branches.
10-
4. Importing for an existing extract file.
11-
12-
To set it up, go to Settings->GP Auto Extract in WordPress. You'll see a list of your projects in GP, you can edit the settings for each one:
13-
14-
1. Source Type
15-
2. Setting
16-
3. Branch/Tag (for GitHub repos only)
17-
4. Use HTTP Basic Authentication (for GitHub repos only)
18-
4. Import from existing file
19-
20-
Each source type has the following settings associated with it:
21-
22-
1. None - Don't auto extract this project.
23-
2. WordPress.org - the slug for the WordPress.org SVN repo to extract from (for example "gp-auto-extract" for this plugin).
24-
3. GitHub - The user name and repo name on GitHub to extract from (for example "toolstack/gp-auto-extract").
25-
4. Custom - a complete url to a ZIP file containing the source code to extract from.
26-
27-
Once the setting has be entered, you can save them with the button to the right and then run an extract which will update the originals in the given project from the source selected.
1+
# GP Auto Extract #
2+
**Contributors:** [gregross](https://profiles.wordpress.org/gregross/), [brazabr](https://profiles.wordpress.org/brazabr/)
3+
**Donate link:** http://toolstack.com/donate
4+
**Plugin URI:** http://glot-o-matic.com/gp-auto-extract
5+
**Author URI:** http://toolstack.com
6+
**Tags:** translation, glotpress
7+
**Requires at least:** 4.4
8+
**Tested up to:** 6.6
9+
**Stable tag:** 0.9
10+
**License:** GPLv2
11+
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
12+
13+
A plugin for GlotPress that adds an option to extract original strings from a remote source repo directly in to a GlotPress project.
14+
15+
## Description ##
16+
17+
A plugin for [GlotPress](https://wordpress.org/plugins/glotpress) that adds an option to extract original strings from a remote source repo directly in to a GlotPress project.
18+
19+
Features:
20+
21+
1. WordPress, GitHub and custom sources.
22+
2. Private GitHub repos with HTTP basic authentication.
23+
3. GitHub tags and branches.
24+
4. Importing for an existing extract file.
25+
26+
To set it up, go to Settings->GP Auto Extract in WordPress. You'll see a list of your projects in GP, you can edit the settings for each one:
27+
28+
1. Source Type
29+
2. Setting
30+
3. Branch/Tag (for GitHub repos only)
31+
4. Use HTTP Basic Authentication (for GitHub repos only)
32+
4. Import from existing file
33+
34+
Each source type has the following settings associated with it:
35+
36+
1. None - Don't auto extract this project.
37+
2. WordPress.org - the slug for the WordPress.org SVN repo to extract from (for example "gp-auto-extract" for this plugin).
38+
3. GitHub - The user name and repo name on GitHub to extract from (for example "toolstack/gp-auto-extract").
39+
4. Custom - a complete url to a ZIP file containing the source code to extract from.
40+
41+
Once the setting has be entered, you can save them with the button to the right and then run an extract which will update the originals in the given project from the source selected.
42+
43+
## Installation ##
44+
45+
Install from the WordPress plugin directory.
46+
47+
## Frequently Asked Questions ##
48+
49+
### Does the plugin support webhooks for remote repos? ###
50+
51+
Not yet, the 1.0 release will likely have support for webhooks so the extract can be executed whenever a remote file changes.
52+
53+
## Changelog ##
54+
### 0.9 ###
55+
* Release Date: October 9, 2024
56+
* Added: Support for WordPress Themes, thanks @pedro-mendonca.
57+
* Fixed: Warnings/errors due to create_function() being removed in PHP8.
58+
* Updated: pomo and extract functions from WP and WP I18N libraries respectivly.
59+
60+
### 0.8 ###
61+
* Release Date: January 16, 2017
62+
* Info: Welcome new contributor brazabr!
63+
* Added: Support for HTTP Basic Authentication for GitHub (thanks brazabr).
64+
* Added: Option to skip POT generation and import an existing file from repository/archive (thanks brazabr).
65+
* Added: Option to override GitHub branch or tag (thanks brazabr).
66+
* Updated: UI for editing each project setting (thanks brazabr).
67+
68+
### 0.7 ###
69+
* Release Date: January 10, 2017
70+
* Added: Auto Extract option to the projects menu on the front end.
71+
* Fixed: Various WP_DEBUG warnings.
72+
* Fixed: Better handling of corrupt zip files.
73+
* Fixed: Make sure to remove temporary files.
74+
* Fixed: Source file references would incorrectly include plugin top level directory, thanks @brazabr.
75+
76+
### 0.6 ###
77+
* Release Date: March 18, 2016
78+
* Documentation updates.
79+
80+
### 0.5
81+
* Release Date: January 28, 2016
82+
* Initial release.
83+
###

0 commit comments

Comments
 (0)