Skip to content

Commit 5265d72

Browse files
committed
Updated README.md
1 parent 74718e2 commit 5265d72

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
A simple deploy script to push any branch from your GitHub repository to your WordPress.org plugin SVN for a new release.
44

5+
Quick Links: [Overview](#-overview) | [Features](#-features) | [Usage](#-usage) | [Contribute](#-contribute)
6+
7+
8+
###### Follow me
9+
10+
💻 [Website](https://sebastiendumont.com) 🐦[Twitter](https://twitter.com/sebd86)
11+
512
## 🔔 Overview
613

714
Releasing WordPress plugins can be quite a chore so a script that handles all of that for you is very helpful. This allows you to do that.
@@ -10,15 +17,13 @@ This script is dummy proof and you do NOT need to configure anything so long as
1017

1118
Just run the script and follow the instructions as you go along and your new release will be up in no time.
1219

13-
14-
### Is This Free?
20+
### 😄 Is This Free?
1521

1622
Yes, it's free. But here's what you should _really_ care about:
1723
* Steps are easy to understand.
1824
* Does everything for you.
1925

20-
21-
### What's the Catch?
26+
### ❓ What's the Catch?
2227

2328
This is a non-commercial script. As such:
2429

@@ -29,12 +34,13 @@ This is a non-commercial script. As such:
2934
Please understand that this repository is not a place to seek help. Use it to report bugs, propose improvements, or discuss new features.
3035

3136
## ✔️ Features
37+
3238
* Supports HTTPS and SSH connections.
3339
* Specify your remote when fetching from your repository.
3440
* Supports Windows if you have TortoiseSVN installed.
3541

36-
3742
## What does the script do?
43+
3844
This script will pull down your remote GIT and SVN repositories, tag a release using the branch you specify, and commit everything to WordPress.org.
3945

4046
As you run the script it will asks questions at certain points to setup the process of the script such as the ROOT Path of your plugin, your GitHub username, repository slug etc.
@@ -84,7 +90,6 @@ The following file types are removed from the parent directory of the plugin loc
8490

8591
Don't see a file that needs to be removed. Create an issue and let me know which file or folder that needs to be removed.
8692

87-
8893
## ✅ Requirements
8994

9095
To use the script you must:
@@ -93,42 +98,49 @@ To use the script you must:
9398
2. Already have a WordPress.org SVN repository setup for your plugin.
9499
3. Have both GIT and SVN setup on your machine and available from the command line.
95100

96-
97101
## Usage
98102

99103
1. Open up terminal/command prompt and change to the directory containing the script.
100104
2. Run: ```sh release.sh```
101105
3. Follow the prompts.
102106

103-
104107
## ⭐ Feedback
105108

106109
GitHub to WordPress.org Deployment Script is released freely and openly. Feedback or ideas and approaches to solving limitations in GitHub to WordPress.org Deployment Script is greatly appreciated.
107110

108-
109111
#### 📝 Reporting Issues
110112

111113
If you think you have found a bug in the script, please [open a new issue](https://github.com/seb86/github-to-wordpress-deploy-script/issues/new) and I will do my best to help you out.
112114

115+
## 👍 Contribute
113116

114-
## Contribute
115-
116-
If you or your company use GitHub to WordPress.org Deployment Script or appreciate the work I’m doing in open source, please consider supporting me directly so I can continue maintaining it and keep evolving the project. It's pretty clear that software actually costs something, and even though it may be offered freely, somebody is paying the cost.
117+
If you or your company use **GitHub to WordPress.org Deployment Script** or appreciate the work I’m doing in open source, please consider supporting me directly so I can continue maintaining it and keep evolving the project.
117118

118-
You'll be helping to ensure I can spend the time not just fixing bugs, adding features, releasing new versions, but also keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.
119+
You'll be helping to ensure I can spend the time not just fixing bugs, adding features or releasing new versions but also keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.
119120

120-
Please also consider starring ✨ and sharing 👍 the repo! This helps the project getting known and grow with the community. 🙏
121+
Please also consider starring ✨ and sharing 👍 the project repository! This helps the project getting known and grow with the community. 🙏
121122

122-
If you want to do a one-time donation, you can donate to:
123+
I accept one-time donations and monthly via [BuyMeACoffee.com](https://www.buymeacoffee.com/sebastien)
123124
- [My PayPal](https://www.paypal.me/codebreaker)
124125
- [BuyMeACoffee.com](https://www.buymeacoffee.com/sebastien)
126+
- Bitcoin (BTC): `3L4cU7VJsXBFckstfJdP2moaNhTHzVDkKQ`
127+
- Ethereum (ETH): `0xc6a3C18cf11f5307bFa11F8BCBD51F355b6431cB`
128+
- Litecoin (LTC): `MNNy3xBK8sM8t1YUA2iAwdi9wRvZp9yRoi`
125129

126130
Thank you for your support! 🙌
127131

128-
129132
## Final Notes
130133

131134
- This will checkout the remote version of your GitHub repository.
132135
- Committing to WordPress.org can take a while so be patient.
133136
- Use at your own risk of course :smile:
134137

138+
##### Credits
139+
140+
GitHub to WordPress.org Deployment Script is developed and maintained by [Sébastien Dumont](https://sebastiendumont.com/about/).
141+
142+
---
143+
144+
<p align="center">
145+
<img src="https://raw.githubusercontent.com/seb86/my-open-source-readme-template/master/a-sebastien-dumont-production.png" width="353">
146+
</p>

0 commit comments

Comments
 (0)