Skip to content

Commit b19def9

Browse files
committed
Version 1.1.0 of the plugin; including Readme update und re-structuring
1 parent 21bbef8 commit b19def9

File tree

2 files changed

+447
-251
lines changed

2 files changed

+447
-251
lines changed

README.md

Lines changed: 108 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,93 @@
11
# Portfolio Content (CPT)
22

3+
Simple Portfolio custom post type for custom content. An **easy drop-in solution** – fast, simple, lightweight!
4+
35
* Contributors: [David Decker](https://github.com/deckerweb), [contributors](https://github.com/deckerweb/portfolio-content/graphs/contributors)
46
* Tags: portfolio, content, cpt, post type, custom
5-
* Requires at least: 4.7
6-
* Tested up to: 5.2
7+
* Requires at least: 6.7
8+
* Requires PHP: 7.4
9+
* Stable tag: [master](https://github.com/deckerweb/portfolio-content/releases/latest)
710
* Stable tag: master
811
* Donate link: [https://www.paypal.me/deckerweb](https://www.paypal.me/deckerweb)
9-
* License: GPL-2.0+
10-
* License URI: [http://www.opensource.org/licenses/gpl-license.php](http://www.opensource.org/licenses/gpl-license.php)
12+
* License: GPL v2 or later
13+
14+
---
15+
16+
[Support Project](#support-the-project) | [Installation](#installation) | [Updates](#updates) | [Description](#description) | [Features](#features) | [Translations](#translations) | [Changelog](#changelog--version-history) | [Plugin Scope / Disclaimer](#plugin-scope--disclaimer)
17+
18+
---
19+
20+
## Support the Project
21+
22+
If you find this project helpful, consider showing your support by buying me a coffee! Your contribution helps me keep developing and improving this plugin.
23+
24+
Enjoying the plugin? Feel free to treat me to a cup of coffee ☕🙂 through the following options:
25+
26+
- [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W81BNTZE)
27+
- [Buy me a coffee](https://buymeacoffee.com/daveshine)
28+
- [PayPal donation](https://paypal.me/deckerweb)
29+
- [Join my **newsletter** for DECKERWEB WordPress Plugins](https://eepurl.com/gbAUUn)
30+
31+
---
32+
33+
## Installation
34+
35+
#### **Quick Install – as Plugin**
36+
1. **Download ZIP:** [**portfolio-content.zip**](https://github.com/deckerweb/portfolio-content/releases/latest/download/portfolio-content.zip)
37+
2. Upload via WordPress Plugins > Add New > Upload Plugin
38+
3. Once activated, you can see Portfolio admin menu – just add content
39+
 
40+
#### **Alternative: Use as Code Snippet**
41+
1. Below, download the appropriate snippet version
42+
2. activate or deactivate in your snippets plugin
43+
44+
[**Download .json**](https://github.com/deckerweb/portfolio-content/releases/latest/download/ddw-portfolio-content.code-snippets.json) version for: _Code Snippets_ (free & Pro), _Advanced Scripts_ (Premium), _Scripts Organizer_ (Premium)
45+
--> just use their elegant script import features
46+
--> in _Scripts Organizer_ use the "Code Snippets Import"
47+
48+
For all other snippet manager plugins just use our plugin's main .php file [`portfolio-content.php`](https://github.com/deckerweb/portfolio-content/blob/master/portfolio-content.php) and use its content as snippet (bevor saving your snippet: please check for your plugin if the opening php tag needs to be removed or not!).
49+
Also NOTE: When using the snippet version you have to re-save the Permalinks in WordPress _after activating_ the code snippet!
50+
51+
--> Please decide for one of both alternatives!
52+
53+
---
54+
55+
## Updates
56+
57+
#### For Plugin Version:
1158

12-
Simple Portfolio custom post type for custom content.
59+
1) Alternative 1: Just download a new [ZIP file](https://github.com/deckerweb/portfolio-content/releases/latest/download/portfolio-content.zip) (see above), upload and override existing version. Done.
1360

61+
2) Alternative 2: Use the (free) [**_Git Updater_ plugin**](https://git-updater.com/) and get updates automatically.
1462

15-
## Description:
63+
3) Alternative 3: Upcoming! – In future I will built-in our own deckerweb updater. This is currently being worked on for my plugins. Stay tuned!
1664

17-
The Portfolio CPT is defacto like "Posts" but just on its own.
65+
#### For Code Snippet Version:
1866

19-
The Post Type comes with two taxonomies registered as well, Portfolio Categories and Portfolio Tags.
67+
Just manually: Download the latest Snippet version (see above) and import it in your favorite snippets manager plugin. – You can delete the old snippet; then just activate the new one. Done.
2068

21-
This plugin is fully translateable by default so it works perfectly for multlingual installs - and multilingual plugins like Polylang.
69+
---
70+
71+
## Description
72+
73+
The Portfolio CPT is defacto like "Posts" but just on its own.
74+
A **simple drop-in solution** – fast, easy, lightweight!
75+
76+
The Post Type comes with two taxonomies registered as well, _Portfolio Categories_ and _Portfolio Tags_.
77+
78+
This plugin is fully translateable by default so it works perfectly for multlingual installs - and multilingual plugins like _Polylang_.
2279

2380
The available filters allow you to tweak all registered arguments for the post type and its taxonomies. For example, you would also be able to change the slugs on a per language basis via filter functions that way.
2481

82+
---
2583

26-
## Features:
84+
## Features
2785

28-
* Simple post type - all that you know and would expect
29-
* Nothing extra -- use custom field plugins like ACF or Pods, please
86+
* Simple post type - all that you know and would expect – slug: `portfolio-content`
87+
* Nothing extra use custom field plugins like Meta Box, ACPT, ACF, JetEngine or Pods, please
3088
* Gutenberg enabled by default (in post type parameters)
31-
* Taxonomy: Portfolio Categories
32-
* Taxonomy: Portfolio Tags
89+
* Taxonomy: Portfolio Categories – slug: `portfolio-category`
90+
* Taxonomy: Portfolio Tags – slug: `portfolio-tag`
3391
* Filters for all 3 registrations available to tweak the arguments if needed
3492

3593

@@ -53,8 +111,9 @@ The available filters allow you to tweak all registered arguments for the post t
53111
* Setting your GitHub API Token is recommended! :)
54112
* It's so easy and seamless you won't find any better solution for this ;-)
55113

114+
---
56115

57-
## Translations:
116+
## Translations
58117

59118
### Localization & Internationalizaton:
60119

@@ -65,4 +124,37 @@ The available filters allow you to tweak all registered arguments for the post t
65124
* *Recommended:* Global WordPress lang dir path for translations: `wp-content/languages/plugins/portfolio-content-de_DE.mo` ---> *NOTE: if this file/path exists it will be loaded at higher priority than the plugin path! This is the recommended path & way to store your translations as it is update-safe and allows for custom translations!*
66125
* Recommended translation tools: **Poedit** (free) OR **Poedit Pro**
67126

68-
Copyright (c) 2019 David Decker - DECKERWEB
127+
---
128+
129+
## Changelog
130+
131+
### 🎉 v1.1.0 – 2025-04-??
132+
* Bring back the plugin to a new life
133+
* New: Transformed code into class-based approach (more future-proof)
134+
* New: Flush permalink rewrite rules on plugin activation (and only then)
135+
* New: Installable and updateable via [Git Updater plugin](https://git-updater.com/)
136+
* Plugin: Add meta links on WP Plugins page
137+
* Alternate install: Use "plugin" as Code Snippet version – now officially promoted here in Readme and with downloadable `.json` file
138+
* Updated `.pot` file, plus packaged German translations, now including new `l10n.php` files!
139+
140+
### 🎉 v1.0.0 – 2019-05-09
141+
* Everything's new 👍
142+
* Initial _public_ release on GitHub
143+
144+
---
145+
146+
## Plugin Scope / Disclaimer
147+
148+
This plugin comes as is.
149+
150+
_Disclaimer 1:_ So far I will support the plugin for breaking errors to keep it working. Otherwise support will be very limited. Also, it will NEVER be released to WordPress.org Plugin Repository for a lot of reasons (ah, thanks, Matt!).
151+
152+
_Disclaimer 2:_ All of the above might change. I do all this stuff only in my spare time.
153+
154+
_Most of all:_ Have fun building great sites!!! ;-)
155+
156+
---
157+
158+
Icon used in promo graphics: [© Remix Icon](https://remixicon.com/)
159+
160+
Readme & Plugin Copyright: © 2019-2025, David Decker - DECKERWEB

0 commit comments

Comments
 (0)