summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Kiss2008-01-05 16:03:09 (GMT)
committer Dominik Kiss2008-01-05 16:03:09 (GMT)
commitf1c26b08f7d687d261940875c61f82b6fcb62972 (patch)
treed6508ea8a142471f628f3d59106fb298a606b1c4
parent70a25f3e9321f8ea24a5219f26c7224fef07f14b (diff)
adapted readme file
-rw-r--r--buddy_api/README.txt6
-rw-r--r--buddylist_ui/README.txt79
2 files changed, 52 insertions, 33 deletions
diff --git a/buddy_api/README.txt b/buddy_api/README.txt
index d6e07ec..9ed27ba 100644
--- a/buddy_api/README.txt
+++ b/buddy_api/README.txt
@@ -2,7 +2,7 @@
D R U P A L M O D U L E
********************************************************************
Name: Buddy API
-Author: Dominik Kiss <dominik.kiss[at]gmx.at>
+Author: Dominik Kiss <dominik.kiss[at]gmx.at> nodestroy at drupal.org
Drupal Version: 5
********************************************************************
DESCRIPTION:
@@ -38,7 +38,7 @@ INSTALLATION:
This will create the necessary database tables for you.
NOTE: If you are updating from old buddylist, the given tables
- are used, so you will not lose your buddyconnections.
- (backup it befor you install the new module)
+ are used, so you will not lose your buddy- connections.
+ (backup it before you install the new module)
diff --git a/buddylist_ui/README.txt b/buddylist_ui/README.txt
index e9c789d..1870f0a 100644
--- a/buddylist_ui/README.txt
+++ b/buddylist_ui/README.txt
@@ -2,42 +2,62 @@
D R U P A L M O D U L E
********************************************************************
Name: Buddylist UI
-Author: Dominik Kiss <dominik.kiss[at]gmx.at>
+Author: Dominik Kiss <dominik.kiss[at]gmx.at> nodestroy at drupal.org
+Thanks to: dkruglyak at drupal.org
Drupal Version: 5
********************************************************************
DESCRIPTION:
-Buddylist UI is an userinterface for Buddy API. All listings are
-realised with views, so you can adapt and theme how you want.
-
-Notifications are done with workflow NG, so you can adjust it how
-you want (send mails, show messages, logging,...). A default
-configuration is provided, so you just have to install the module,
-and you have a running buddy system.
+Buddylist UI is an user-interface for Buddy API. All listings are
+done with views, so you can adapt and theme the listings how you want.
Required Modules are:
- usernode (to list users via views. usernode is NO profile solution)
- views
- - workflow_ng
+
+Recommended Modules are:
+ - workflow-ng
- token
+
+If you use workflow-ng you can easy adapt all messages over the
+workflow-ng UI. Further you are able to send mails on various buddy
+events (userA requests userB to be his buddy). Buddy_api has a few
+workflow-ng configurations onboard. Just install workflow-ng to have
+customizable mails and messages. Furthermore, the default buddy_api
+workflow-ng configuration logs all user actions to watchdog.
+
+Supported operation modes are:
+ - one-way connections
+ - two-way connections
-Supported Actions:
-- Request to add UserX to your buddylist (with a personal message)
-- Cancel your request to UserX
-- UserX accepts your request
-- UserX declines your request
+That means, you can decide if there should be only one connection
+(a->b) or a double connection: a<->b (a->b AND b->a)
+
+Supported actions:
+ - one-way:
+ * userA adds userB to his buddylist
+ * userA deletes userB from his buddylist
+ [* show buddylist of userX]
+
+ - two-way:
+ * show buddylist of userX
+ * userA requests to add userB (with message)
+ * userA cancels request to userB
+ * userB accepts request
+ * userB declines request
+ * userA deletes userB from his buddylist
Default Views:
-- sent requests
-- received requests
-- buddylist
+- buddylist
+- sent requests
+- received requests
Default actions (all configurable via workflow_ng):
-- log every buddyaction to watchdog
+- log every buddy-action to watchdog
- send a mail when UserA requests to add UserB
- send a mail when UserB accepts request from UserA
- show messages at every buddy action
-you can add, edit and delete actions at the workflow admin interface.
+you can add, edit and delete actions at the workflow UI
********************************************************************
INSTALLATION:
@@ -46,7 +66,7 @@ INSTALLATION:
directory (/sites/all/modules)
2. Download all required modules from drupal.org and place it into
- the same directory.
+ the same directory. (usernode + views [+ workflow-ng + token])
3. Enable the modules at:
administer -> site building -> modules
@@ -66,22 +86,21 @@ INSTALLATION:
administer -> site building -> views
(Views UI must be enabled to do this)
-7. goto ?q=buddylist/buddylistpage and see your buddylist
- central managing page
+7. goto ?q=buddylist and see your buddylist central managing page
+ [add a menu item, which points to ?q=buddylist]
8. have fun ;)
********************************************************************
-USE OF VIEWS:
+USE OF VIEWS (advanced):
+
+NOTE: the buddylist view is integrated in every user page (by default)
-- The "buddylist" view uses arguments to list the users. To list
- friends of user with id 4 you have to call the view with arg 4:
- index.php?q=buddylisting/4
+- The "buddylist" view uses arguments to list the buddylist of another
+ user. To list friends of user with uid 4, you have to call the view
+ with arg 4: index.php?q=buddylisting/4
buddylisting = name of view
-********************************************************************
-TRANSLATION:
-- use Localization module to translate strings
-- rename the views (Buddylist, Pending Requests, Sent Requests)
+