fix: update docs, move solr.d.ts to types.d.ts

Author: vsimko

README.md

@@ -8,20 +8,19 @@
 - plain javascipt in commonjs format - no additional build step required
 - ES6+ including async/await, lambdas, spread operator...
 - typechecking support in vscode (without compiling typescript code)
-- no dependencies other than `axios`
+- no runtime dependencies other than `axios`
 - as close as possible to the Solr Json-based REST API
-- functions for working with document, fields and field types
+- functions for working with documents, fields, field types, cores
 
 # Example
 
 ```js
 const { prepareSolrClient } = require("node-solr-lambda");
-const solr = prepareSolrClient({ core: "mycore" });
+const solr = prepareSolrClient("mycore");
 
 async function myfun() {
-  const mycoreExists = await solr.ping(); // -> true if "mycore" exists
   const result = await solr.query({ query: "label:something" });
-  console.log(result.data);
+  console.log(result);
 
   await solr.addField({ name: "price", type: "plong", multiValued: false });
   await solr.addField({
@@ -35,6 +34,7 @@ async function myfun() {
   const item2 = { id: "item2", price: 456, category: ["cpu", "usb"] };
   await solr.add(item1); // works with single object
   await solr.add([item1, item2]); // works with object[]
+  await solr.commit()
 
   await solr.query({
     query: "*:*",

src/index.js

@@ -1,15 +1,15 @@
 // @ts-check
 /**
  * Support for type checking and intellisense in vscode:
- * @typedef {import("./solr").SolrConfig} SolrConfig
- * @typedef {import("./solr").ConfigRequest} ConfigRequest
- * @typedef {import("./solr").SolrException} SolrException
- * @typedef {import("./solr").SolrDocument} SolrDocument
- * @typedef {import("./solr").SolrResponse} SolrResponse
- * @typedef {import("./solr").DeleteRequest} DeleteRequest
- * @typedef {import("./solr").FieldProperties} FieldProperties
- * @typedef {import("./solr").FieldTypeProperties} FieldTypeProperties
- * @typedef {import("./solr").QueryRequest} QueryRequest
+ * @typedef {import("./types").SolrConfig} SolrConfig
+ * @typedef {import("./types").ConfigRequest} ConfigRequest
+ * @typedef {import("./types").SolrException} SolrException
+ * @typedef {import("./types").SolrDocument} SolrDocument
+ * @typedef {import("./types").SolrResponse} SolrResponse
+ * @typedef {import("./types").DeleteRequest} DeleteRequest
+ * @typedef {import("./types").FieldProperties} FieldProperties
+ * @typedef {import("./types").FieldTypeProperties} FieldTypeProperties
+ * @typedef {import("./types").QueryRequest} QueryRequest
  * @typedef {{name:string, type?:string, [key:string]:any}} FieldDef
  * @typedef {import("axios").AxiosResponse} AxiosResponse
  */