Browse Source

update README

Kieran Gibb 2 years ago
parent
commit
48c4becfc0
No known key found for this signature in database
1 changed files with 4 additions and 2 deletions
  1. 4
    2
      README.md

+ 4
- 2
README.md View File

@@ -1,3 +1,5 @@
1
-# cobox-group-base
1
+# cobox-replicator
2 2
 
3
-Base class for cobox groups, and a class containing an intialised multifeed for blind replication.
3
+A base class for replication. Initialises keys with validations, sets up storage paths, initialises feeds and enables replication.
4
+
5
+These are all common functions for any group class, so we can inherit from the replicator class to extend functionality, such as for group, or admin group, which initialize additional but different logs.