@naturalcycles/abba 1.8.0 → 1.9.0

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/package.json +1 -1
  2. package/readme.md +6 -6
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@naturalcycles/abba",
3
- "version": "1.8.0",
3
+ "version": "1.9.0",
4
4
  "scripts": {
5
5
  "prepare": "husky install",
6
6
  "build": "build",
package/readme.md CHANGED
@@ -90,14 +90,14 @@ This template doesn't rely on any external dependencies or services._
90
90
 
91
91
  ### Create an instance of Abba
92
92
 
93
- Creates an instance of Abba. You can pass in the database url in the constructor. If it does not
94
- exist it will fallback to trying to use the `ABBA_DB_URL` which must be added to your environment
95
- variables.
93
+ (Currently supports MySQL, probably all DocumentDBs but not verified.)
96
94
 
97
95
  ```js
98
- const abba = new Abba('url')
99
- // or reading from process.env.ABBA_DB_URL
100
- const abba = new Abba()
96
+ type AbbaConfig = {
97
+ db: CommonDB // from @naturalcycles/db-lib
98
+ }
99
+
100
+ const abba = new Abba(config: AbbaConfig)
101
101
  ```
102
102
 
103
103
  ### Create a new experiment