occam-entities 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -29
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Occam File system
1
+ # Occam Entities
2
2
 
3
3
  [Occam](https://github.com/djalbat/occam)'s entities.
4
4
 
@@ -12,17 +12,17 @@
12
12
 
13
13
  ## Introduction
14
14
 
15
- Occam's file system functionality.
15
+ Occam's entities, namely things like files, projects, versions and so on.
16
16
 
17
17
  ## Installation
18
18
 
19
19
  With [npm](https://www.npmjs.com/):
20
20
 
21
- npm install occam-file-system
21
+ npm install occam-entities
22
22
 
23
23
  You can also clone the repository with [Git](https://git-scm.com/)...
24
24
 
25
- git clone https://github.com/djalbat/occam-file-system.git
25
+ git clone https://github.com/djalbat/occam-entities.git
26
26
 
27
27
  ...and then install the dependencies with npm from within the project's root directory:
28
28
 
@@ -30,40 +30,40 @@ You can also clone the repository with [Git](https://git-scm.com/)...
30
30
 
31
31
  ## Usage
32
32
 
33
- The exported functions are:
33
+ The exported classes are:
34
34
 
35
- * `loadFile()`
36
- * `saveFile()`
37
- * `loadFiles()`
38
- * `loadProjects()`
39
- * `moveProjectEntries()`
40
- * `removeProjectEntries()`
35
+ * `File`
36
+ * `Files`
37
+ * `Version`
38
+ * `Entries`
39
+ * `Project`
40
+ * `Release`
41
+ * `Projects`
42
+ * `Releases`
43
+ * `Dependency`
44
+ * `Dependencies`
45
+ * `ShortenedVersion`
41
46
 
42
- Typical usage is as follows:
47
+ There are also some utilities:
43
48
 
44
- ```
45
- const open = require('occam-open-cli'), ///
46
- filesystem = require('occam-file-system'); ///
49
+ * `contentUtilities`
50
+ * `filePathUtilities`
51
+ * `metaJSONUtilities`
47
52
 
48
- const { Files } = open,
49
- { loadFiles } = filesystem;
53
+ The classes have factory methods, see the source for details. Typical usage is:
50
54
 
51
- const filePaths = ...,
52
- projectsDirectoryPath = ...,
53
- json = {
54
- filePaths
55
- };
55
+ ```
56
+ const { File }} = require('occam-entities');
56
57
 
57
- loadFiles(projectsDirectoryPath, json, function(json) {
58
- const files = (json !== null) ?
59
- Files.fromJSON(json) :
60
- null;
58
+ const json = ... ,
59
+ file = file.fromJSON(json);
61
60
 
62
- ...
63
- });
61
+ ...
64
62
  ```
65
63
 
66
- Note that you get JSON back, not an instance of the `Files` class, and that JSON might be `null`.
64
+ See the source for further information on the utilities.
65
+
66
+ In short, this package has little of use and only a little more of interest.
67
67
 
68
68
  ## Building
69
69
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "occam-entities",
3
3
  "author": "James Smith",
4
- "version": "1.0.2",
4
+ "version": "1.0.4",
5
5
  "license": "MIT, Anti-996",
6
6
  "homepage": "https://github.com/djalbat/occam-entities",
7
7
  "description": "Occam's entities.",