Skip to content

Commit 087d31e

Browse files
authored
Update README for consistency w/ other properties
New Transcoder logo and banner is WIP
1 parent 574774d commit 087d31e

File tree

1 file changed

+29
-39
lines changed

1 file changed

+29
-39
lines changed

README.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,15 @@
1-
# Transcoder #
2-
3-
Transcoding services for ANY WordPress website. Convert audio/video files of any format to a web-friendly format (mp3/mp4).
4-
5-
6-
<a href="https://rtcamp.com/?utm_source=github&utm_medium=readme" rel="nofollow"><img src="https://rtcamp.com/wp-content/uploads/2019/04/[email protected]" alt="Handcrafted Enterprise WordPress Solutions by rtCamp" /></a>
7-
1+
# Transcoder for WordPress #
82
<p align="center">
93
<img src="https://rtmedia.io/wp-content/uploads/2016/08/trancoder-banner-01.png" alt="Transcoder Banner"/>
104
</p>
115

12-
* **Contributors:** [rtcamp] (http://profiles.wordpress.org/rtcamp), [mangeshp] (http://profiles.wordpress.org/mangeshp), [chandrapatel] (http://profiles.wordpress.org/chandrapatel), [manishsongirkar36] (http://profiles.wordpress.org/manishsongirkar36), [bhargavbhandari90] (http://profiles.wordpress.org/bhargavbhandari90), [kiranpotphode] (http://profiles.wordpress.org/kiranpotphode), [thrijith] (http://profiles.wordpress.org/thrijith), [devikvekariya] (http://profiles.wordpress.org/devikvekariya), [sagarnasit] (http://profiles.wordpress.org/sagarnasit), [sudhiryadav] (http://profiles.wordpress.org/sudhiryadav), [sid177] (https://profiles.wordpress.org/sid177/), [pooja1210] (https://profiles.wordpress.org/pooja1210/)
6+
Transcoder is an audio/video transcoding service for any WordPress website. Once this plugin is set up and a license key added, it will automatically intercept any uploaded audio/video files and convert them to a web-friendly format (mp3/mp4) via our Transcoder service. This eliminates the need for a dedicated media node - no fiddling with installation, managing dependencies or renting servers.
137

14-
* **License:** [GPL v2 or later] ( http://www.gnu.org/licenses/gpl-2.0.html)
8+
Transcoder works for any WordPress website, including on shared hosting - just install this plugin, [subscribe to a plan](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder) and go!
159

16-
## Description ##
17-
Transcoder easily converts all audio and video files uploaded to your website to a web-friendly format.
10+
⚠ Transcoder only works with an active subscription plan. ⚠
1811

19-
Transcoder eliminates the need for a dedicated media node- no fiddling with installation, managing dependancies or renting servers! Transcoder also works on shared hosting- just install, subscribe and go!
20-
21-
All transcoding services are available via a subscription plan through this plugin.
22-
Subscribe to our free plan from the plugin's settings or from our [product page](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder). Note that Transcoder will not provide any services without a subscription plan.
12+
This plugin is licensed under [GPL v2 or later](http://www.gnu.org/licenses/gpl-2.0.html).
2313

2414
#### Supported input media types: ####
2515
* Audio: mp3, m4a, wav, ogg, wma
@@ -29,40 +19,38 @@ Subscribe to our free plan from the plugin's settings or from our [product page]
2919
* Audio: mp3
3020
* Video: mp4
3121

32-
Create the ultimate niche community by combining Transcoder with our [rtMedia](https://wordpress.org/plugins/buddypress-media/) plugin. Transcoder works perfectly with rtMedia to create a social experience that is accessible across all desktop and mobile devices.
33-
34-
#### Transcoder Features ####
35-
1. **Works with ANY WordPress website** - Transcoder plugs into your current website seamlessly, instantly improving user audio/video experience.
36-
2. **rtMedia integration** - Works perfectly with our own [rtMedia](https://rtmedia.io/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder), for a complete social media platform.
37-
3. **Thumbnail generation** - Automatically generate up to 10 thumbnails for every video, from which your users can choose one.
22+
#### Highlighted Features ####
23+
1. **Works with any WordPress website** - Transcoder plugs into your current website seamlessly, improving media compatibility.
24+
2. **Thumbnail generation** - Automatically generate up to 10 thumbnails for videos.
25+
3. **rtMedia integration** - Create the ultimate niche community that is accessible across all desktop and mobile devices by combining Transcoder with [rtMedia](https://wordpress.org/plugins/buddypress-media/).
3826
4. **[rt_media] shortcode** - Use our shortcode to display transcoded audio/video file on any post or page. For example, [rt_media attachment_id=xx] the attachment_id parameter specifies the file to be displayed.
3927

4028
#### Privacy Warning ####
41-
In order for us to transcode your media files, we need to copy it over to our server.
42-
After transcoding is completed, the media can reside on our server for a maximum of 24 hours, before it is permanently and irreversibly removed by a Cron job.
29+
In order to transcode any media file, Transcoder has to run it through a dedicated server. After transcoding is completed, the media can reside on this server for a maximum of 24 hours, before it is permanently and irreversibly removed by a Cron job.
4330

44-
#### Future Roadmap ####
31+
#### Project Roadmap ####
4532
* Additional output formats for video- ogg, webm
4633
* Downsampling capabilities for output video resolution
4734
* RESTful API
4835

49-
#### Important Links ####
50-
* [Project Homepage](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder "Visit Transcoder's Homepage")
51-
* [Documentation](https://rtmedia.io/docs/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder "Visit Transcoder's Documentation page")
52-
* [FAQ](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder#frequently-asked-questions "Visit FAQ page")
53-
* [GitHub](https://github.com/rtCamp/transcoder/) - Please mention your wordpress.org username when sending pull requests.
36+
## Screenshots
37+
Transcoder Settings Page
38+
39+
![Transcoder Settings Page](https://rtcamp.com/wp-content/uploads/2020/09/settings_transcoder-1-without-annotations.png "Transcoder Settings Page")
5440

55-
## Installation ##
56-
* Install the plugin from the 'Plugins' section in your dashboard (Go to `Plugins > Add New > Search` and search for "Transcoder").
57-
* Alternatively, you can download the plugin from this [plugin directory](http://downloads.wordpress.org/plugin/transcoder.zip "Download Transcoder"). After downloading, unzip and upload it to the plugins folder of your WordPress installation (`wp-content/plugins/` directory of your WordPress installation).
58-
* Activate it through the 'Plugins' section.
41+
Media re-transcoding in progress
5942

60-
## Frequently Asked Questions ##
61-
Please visit [FAQ page](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder#frequently-asked-questions "Visit FAQ page").
62-
Read [Documentation](https://rtmedia.io/docs/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder "Visit Transcoder's Documentation page")
43+
![Media re-transcoding in progress](https://rtcamp.com/wp-content/uploads/2020/09/retranscoding-screenshot-complete-sh-720x259-1.png "Media re-transcoding in progress")
6344

64-
## Screenshots ##
65-
1. Transcoder Settings
45+
## Installation
46+
1. Install the plugin from the 'Plugins' section in your WordPress dashboard (Go to `Plugins > Add New > Search` and search for "Transcoder").
47+
1. Alternatively, you can download the plugin from [this repository](http://downloads.wordpress.org/plugin/transcoder.zip "Download Transcoder"), unzip and upload it to the plugins folder of your WordPress installation (`wp-content/plugins/`).
48+
1. Activate Transcoder through the 'Plugins' section.
49+
1. Add your API key after subscribing to a plan either from the plugin’s interface or from [here](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder).
50+
1. Click on 'Enable Transcoding' to start the transcoding service. From this point onward, all audio/video uploaded to your website is automatically transcoded.
51+
52+
## FAQ
53+
Visit Transcoder’s [FAQ page](https://rtmedia.io/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder#frequently-asked-questions "Visit FAQ page") or read the [project documentation](https://rtmedia.io/docs/transcoder/?utm_source=readme&utm_medium=plugin&utm_campaign=transcoder "Visit Transcoder's Documentation page")
6654

6755
## Changelog ##
6856
#### 1.3.1 [August 14, 2020] ####
@@ -189,5 +177,7 @@ Read [Documentation](https://rtmedia.io/docs/transcoder/?utm_source=readme&utm_m
189177

190178
#### 1.0.0 ####
191179
Initial release
180+
* Transcoder 1.3.1, with WordPress 5.5 compatibility and media thumbnails auto update feature after transcoding is completed on rtMedia pages.
192181

193-
Transcoder 1.3.1, with WordPress 5.5 compatibility and media thumbnails auto update feature after transcoding is completed on rtMedia pages.
182+
## BTW, We're Hiring!
183+
<a href="https://rtcamp.com/?utm_source=github&utm_medium=readme" rel="nofollow"><img src="https://rtcamp.com/wp-content/uploads/2019/04/[email protected]" alt="Handcrafted Enterprise WordPress Solutions by rtCamp" /></a>

0 commit comments

Comments
 (0)