forked from woocommerce/projects
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
96 lines (56 loc) · 4.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
=== Projects by WooThemes ===
Contributors: woothemes, mattyza, jameskoster, tiagonoronha
Donate link: http://woothemes.com/
Tags: portfolio, projects, project, showcase, artwork, work, creative, photography, art
Requires at least: 3.8
Tested up to: 3.8.1
Stable tag: 1.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Hi, I'm your projects showcase plugin for WordPress. Use me to show off a portfolio of your latest work.
== Description ==
"Projects" by WooThemes is a clean and easy-to-use portfolio showcase management system for WordPress. Load in your recent projects, and display them on a specified page using our template system, or via a shortcode, widget or template tag.
= Easy to use =
Publish and categorise your projects using the familiar WordPress interface.
= Detailed project information =
Include full project details such as cover images, galleries, categories, client details and projects URLs.
= Fully integrated with WordPress =
Display your projects using native WordPress architecture (project archives & single pages).
= Widgets & Shortcodes included =
Use Widgets & Shortcodes for situational project display.
= Mobile friendly =
Projects includes a responsive layout to integrate with any theme.
= Customisable =
Get your hands dirty! Customise & extend Projects via a vast array of hooks, filters & templates.
= Documentation =
Extensive [documentation](http://docs.woothemes.com/documentation/plugins/projects/) to help you out if you get stuck.
== Usage ==
Once installed you can begin adding projects to your portfolio right away via the 'Projects' item in the main menu. But before you do that you should go ahead and create a page for your projects (via the Pages menu item) and specify that page as your projects base page in the projects settings. The interface for adding projects is very similar to adding posts so you should feel right at home.
For more detailed usage instructions take a look at the [Projects Documentation](http://docs.woothemes.com/documentation/plugins/projects/).
== Installation ==
Installing "Projects" can be done either by searching for "Projects by WooThemes" via the "Plugins > Add New" screen in your WordPress dashboard, or by using the following steps:
1. Download the plugin via WordPress.org.
2. Upload the ZIP file through the "Plugins > Add New > Upload" screen in your WordPress dashboard.
3. Activate the plugin through the 'Plugins' menu in WordPress
== Frequently Asked Questions ==
= My project images are blurry / distorted, how do I fix that? =
It's possible that your theme is scaling images to fit their container by setting `width: 100%;`. If this is the case, and your project thumbnails are too small they will become distored / blurred as they are scaled up. To fix this change the project thumbnail size options in the Projects settings then regenerate your thumbnails using the [Regenerate Thumbnails plugin](http://wordpress.org/plugins/regenerate-thumbnails/).
= How do I integrate projects into my theme? =
If you run into layout issues on Projects pages then you will need to peruse one of two methods to make your theme compatible. You can read all about this in the [documentation](http://docs.woothemes.com/document/third-party-theme-compatibility/).
= I want to change X =
Projects uses template files to control the display of it's various components. These templates can be safely editied so that your customisations are not lost during updates as described in the [documentation](http://docs.woothemes.com/document/editing-projects-templates-safely/).
= Is it possible to add cusstom fields to the Project details meta box? =
Yes! You can follow this tutorial to [add custom fields to projects](http://docs.woothemes.com/document/add-a-project-meta-field/) and display them.
= How do I contribute? =
We encourage everyone to contribute their ideas, thoughts and code snippets. This can be done by forking the [repository over at GitHub](http://github.com/woothemes/projects/).
== Screenshots ==
1. The projects base page
2. A single project page
3. The projects management screen within the WordPress dashboard.
== Upgrade Notice ==
= 1.0.0 =
* Initial release. Woo!
== Changelog ==
= 1.0.0 =
* 2014-12-17
* Initial release. Woo!