feat: write README and expose functions (#10)

README.md

@@ -5,7 +5,7 @@
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
 
-.
+Small utility to check if a file is ready to be worked with.
 
 ## Installation
 
@@ -14,19 +14,46 @@
 ## Usage
 
 ```js
-import { myModule } from 'is-my-file-ready';
-
-const result = myModule(args);
-// result is ...
+import isMyFileReady, { sameSize, endsWithStr } from 'is-my-file-ready';
+
+const expectedSize = 4242;
+const expectedEnds = 'sit amet.';
+
+const result = await isMyFileReady('./myfile.txt', [
+  sameSize(expectedSize),
+  endsWithStr(expectedEnds),
+]);
+if (!result.isReady) {
+  result.checks
+    .filter((check) => !check.isReady)
+    .forEach((check) => {
+      let toPrint = '';
+      toPrint += `${check.name} failed. `;
+      switch (check.name) {
+        case 'sameSize':
+          toPrint += `Expected "${expectedSize}", got "${check.size}."`;
+          break;
+        case 'endsWithStr':
+          toPrint += `Expected "${expectedEnds}", got "${check.endsWith}."`;
+          break;
+      }
+      console.log(toPrint);
+    });
+} else {
+  console.log('File is ready !');
+}
 ```
 
+## Documentation
+See [https://zakodium.github.io/is-my-file-ready](https://zakodium.github.io/is-my-file-ready)
+
 ## License
 
 [MIT](./LICENSE)
 
 [npm-image]: https://img.shields.io/npm/v/is-my-file-ready.svg
 [npm-url]: https://www.npmjs.com/package/is-my-file-ready
-[ci-image]: https://github.com/zakodium/is-my-file-ready/workflows/Node.js%20CI/badge.svg?branch=master
+[ci-image]: https://github.com/zakodium/is-my-file-ready/workflows/Node.js%20CI/badge.svg?branch=main
 [ci-url]: https://github.com/zakodium/is-my-file-ready/actions?query=workflow%3A%22Node.js+CI%22
 [codecov-image]: https://img.shields.io/codecov/c/github/zakodium/is-my-file-ready.svg
 [codecov-url]: https://codecov.io/gh/zakodium/is-my-file-ready

package.json

@@ -1,7 +1,7 @@
 {
   "name": "is-my-file-ready",
   "version": "0.0.0",
-  "description": "",
+  "description": "Small utility to check if a file is ready to be worked with.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "keywords": [],

src/checks/index.ts

@@ -0,0 +1,6 @@
+import { editTime } from './editTime';
+import { endsWithBytes } from './endsWithBytes';
+import { endsWithStr } from './endsWithStr';
+import { sameSize } from './sameSize';
+
+export { editTime, endsWithBytes, endsWithStr, sameSize };

src/index.ts

@@ -17,3 +17,4 @@ export default async function isMyFileReady(
 }
 
 export * from './types';
+export * from './checks';