WordPress.org
Get WordPress

Plugin Directory

Changeset 1662392


Ignore:
Timestamp:
05/22/2017 01:53:49 PM (9 years ago)
Author:
netdelight
Message:

improved readme

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sharing-club/trunk/readme.txt

    r1662357 r1662392  
    11=== Sharing Club ===
    22Contributors: netdelight
    3 Tags: share, lend, community, borrow, book, library, buddypress
     3Tags: share, lend, community, borrow, loan, lending, book, library, buddypress, sharing club
    44Requires at least: 4.0
    55Tested up to: 4.7.5
    … …  
    1515
    1616== Description ==
    17 This plugin lets you create a list of the items (like DVD, books, tools...) you want to lend to your users.
    18 They can easily book, comment and rate any item. On the admin side, you can track what you’ve lent, who borrowed it and when.
     17Sharing Club lets you create a list of the items (like DVD, books, tools...) you want to lend to your users.
     18They can easily book, comment and rate any item. On the admin side, you can track what you've lent, who borrowed it and when.
    1919
    2020Useful for any NGO, association or community with a sharing philosophy.
    21 Currently available in English and French, but feel free to translate it (translation files included).
     21Currently available in English and French, but feel free to translate it (using Wordpress [online interface](https://translate.wordpress.org/projects/wp-plugins/sharing-club) or the provided files in the `languages` folder).
    2222
    2323The shared object are based on WordPress "custom posts" type and taxonomy which means that :
    … …  
    2727*   you can search for objects from anywhere in your website, like you would do for any other post
    2828
    29 NB : make sure your theme supports the "featured images" so you can display the shared item picture in your item list.
     29If you like this plugin, I would really appreciate if you can leave it a [positive review](https://wordpress.org/plugins/sharing-club/#reviews) (you need to create a [Wordpress account](https://login.wordpress.org/register) if you don''t have one yet).
    3030
    3131== Installation ==
     32
     33= Automatic installation =
     34
     35The easiest way is to let Wordpress do the job for you :
     361. Log in to your WordPress dashboard
     372. In the dashboard left menu click on Plugins > Add New
     383. Search for *Sharing Club*
     394. Once you found it, simply click on *Install now*
     40
     41= Manual installation =
     42
    32431. Unzip all files to the `/wp-content/plugins/sharing-club` directory
    33 2. Log into WordPress admin and activate the ’Sharing Club’ plugin through the \’Plugins\’ menu
    34 3. Go to *Sharing Club > Add object* in the left-hand menu to add the item you want to lend.
    35 4. Manage your lending through *Sharing Club > Lendings*
     442. Log into WordPress admin and activate the *Sharing Club* plugin through the *Plugins* menu
     453. Go to *Sharing Club > Add object* in the left-hand menu to add the item you want to lend
     464. Manage your lendings through *Sharing Club > Lendings*
    3647
    37 The items list will then be available on this ’archive page’ : `http://yourblog.yourdomain*/shared_item/*`
     48The items list will then be available on this "archive page" : `http://yourblog.yourdomain*/shared_item/*`
    3849
    3950You'll get an e-mail notification when an item is requested.
    … …  
    4354*   `templates/archive-shared_item.php` display the items list based on a custom [walker](https://codex.wordpress.org/Class_Reference/Walker) : `templates/Walker_Category_Posts.php`
    4455*   `templates/single-shared_item.php` display the booking form and all its options.
     56
     57Make sure your theme supports the "featured images" so you can display the shared item picture in your item list.
    4558
    4659NB: dates are currently in the dd/mm/yyyy format
    … …  
    6477
    6578== Frequently Asked Questions ==
    66 *   Can I add more fields to my objects ?
     79*   Can I add more fields to the shared items or the lendings ?
    6780
    6881    Yes, if the "notes" field is not enough, you can add other custom field using [Advanced Custom Fields](https://wordpress.org/plugins/advanced-custom-fields/).
    … …  
    7992    So, feel free to use the other fields from the `wp_comments` table to store extra lending data.
    8093   
    81    
    8294*   Can my members share their own objects ?
    8395
    … …  
    91103
    92104    Yes, you can create a spreadsheet with all your objects, save it in CSV format and use a plugin like [Really Simple CSV Importer](https://wordpress.org/plugins/really-simple-csv-importer/) to import it in your admin.
    93    
    94 == Other Notes ==
    95 This plugin code is yours, feel free to create your own version. However, you can also send me your suggestions, I'll be happy to implement them if they fit the "sharing club" scope and cannot be resolved by another plugin.
    96 And if you like this plugin, I would really appreciate if you can leave it a [positive review](https://wordpress.org/plugins/sharing-club/#reviews) :)
     105
     106*   I find this plugin helpful, how can I help you back ?
     107    If you like this plugin, I would really appreciate if you can leave it a [positive review](https://wordpress.org/plugins/sharing-club/#reviews) (you need to create a [Wordpress account](https://login.wordpress.org/register) if you don''t have one yet)
     108    If you find any bug or if you have some idea to improve this plugin, you can use the [support forum](https://wordpress.org/support/plugin/sharing-club)
Note: See TracChangeset for help on using the changeset viewer.