Changeset 2438301

Timestamp:

12/13/2020 01:02:34 PM (4 years ago)

Author:

roccomarco

Message:

Updated Readme

File:

• piwi-warehouse/trunk/readme.txt (modified) (1 diff)

piwi-warehouse/trunk/readme.txt

@@ -1 @@
-*****************************************************************************
-*** Files Organization                                                    ***
-*****************************************************************************
+=== Piwi Warehouse ===
+Contributors: Rocco Marco Guglielmi (roccomarco), Marisa Monaco
+Tags: warehouse, management system
+Requires at least: 5.0
+Tested up to: 5.6
+Requires PHP: 7.2
+Stable tag: 3.0
+License: GPLv2 or later
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
+ 
+Piwi Warehouse is a simple warehouse management system that allows you to keep track of your items, their location and record loan and restitutions.
+ 
+== Description ==
+ 
+Piwi Warehouse allows to manage your Warehouse. It allows you to add Items into the system organized by Type and create hierarchical Locations. 
 
---{root}                          - Piwi Warehouse main folder.
-  +--index.php                    - Index
-  +--piwi-warehouse.php           - Main plugin file.
-  +--admin/                       - Admin menu manager.
-  |  +--_common/                  - Common engine for the menu manager.
-  |  +--_main/                    - Main page.
-  |  +--caps/                     - Capability page.
-  +--core/                        - Warehouse core.
-  |  +--capabilities/             - Capability engine.
-  |  +--items/                    - Item related code.
-  |  +--js/                       - Core common JS.
-  |  +--lists/                    - List management engine.
-  |  +--movements/                - Movement related code.
-  |  +--lists/                    - List management engine.
-  |  +--notes/                    - Notes engine.
-  +--lib/                         - Utility library.
+An item can then be Purchased and assigned to a specific Location. The system will automatically keep track of the amount of the Item per Location.
 
-*****************************************************************************
-*** Releases and Change Log                                               ***
-*****************************************************************************
+The system allows also to register Holders: this is an entity that can borrow an Item. When you move an Item, the system will automatically keep track of
+the amount and availability of the Item during the entire life cycle of a Movement. An Item can be lent, returned, donated or marked as lost.
 
-*** 3.1.0 ***
-
-- NEW: Purchases are now tied to the locations: when purchasing an item, it is
-       required to assign a destination. Item locations are automatically
-       assigned on a Purchase. Validation mechanism have been changed.
-- NEW: Extended Item Record postbox to handle the availability per location.
-- NEW: Item availabilities are now tied to location. Aside of the total
-       availability, each item has an availability per location.
-- NEW: Implemented a new notes system for Purchase an Movement
-- NEW: Improved Post Submit Box management
-- BUG: Fixed issue with capability page restore action (bug #25)
-       (backported to 3.0.1).
+The movement will keep track of all the operations in its History.