chore(metadata): add repository URL & readme (#989)

algolia · Feb 3, 2020 · fa5bada · fa5bada
1 parent 5b2f816
commit fa5bada
Show file tree

Hide file tree

Showing 16 changed files with 145 additions and 3 deletions.
diff --git a/packages/algoliasearch/README.md b/packages/algoliasearch/README.md
@@ -0,0 +1,82 @@
+<p align="center">
+  <a href="https://www.algolia.com">
+    <img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
+  </a>
+
+  <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
+
+  <p align="center">
+    <a href="https://npmjs.org/package/algoliasearch"><img src="https://img.shields.io/npm/v/algoliasearch.svg?style=flat-square" alt="NPM version"></img></a>
+    <a href="http://npm-stat.com/charts.html?package=algoliasearch"><img src="https://img.shields.io/npm/dm/algoliasearch.svg?style=flat-square" alt="NPM downloads"></a>
+    <a href="https://www.jsdelivr.com/package/npm/algoliasearch"><img src="https://data.jsdelivr.com/v1/package/npm/algoliasearch/badge" alt="jsDelivr Downloads"></img></a>
+    <a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a>  •
+  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
+  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
+  <a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/support" target="_blank">Support</a>
+</p>
+
+## ✨ Features
+
+- Thin & **minimal low-level HTTP client** to interact with Algolia's API
+- Works both on the **browser** and **node.js**
+- **UMD compatible**, you can use it with any module loader
+- Built with TypeScript
+
+## 💡 Getting Started
+
+First, install Algolia JavaScript API Client via the [npm](https://www.npmjs.com/get-npm) package manager:
+
+```bash
+npm install algoliasearch
+```
+
+Then, create objects on your index:
+
+```js
+const algoliasearch = require("algoliasearch");
+
+const client = algoliasearch("YourApplicationID", "YourAdminAPIKey");
+const index = client.initIndex("your_index_name");
+
+const objects = [
+  {
+    objectID: 1,
+    name: "Foo"
+  }
+];
+
+index
+  .saveObjects(objects)
+  .then(({ objectIDs }) => {
+    console.log(objectIDs);
+  })
+  .catch(err => {
+    console.log(err);
+  });
+```
+
+Finally, let's actually search using the `search` method:
+
+```js
+index
+  .search("Fo")
+  .then(({ hits }) => {
+    console.log(hits);
+  })
+  .catch(err => {
+    console.log(err);
+  });
+```
+
+For full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
+
+## 📄 License
+
+Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.txt).
diff --git a/packages/algoliasearch/package.json b/packages/algoliasearch/package.json
@@ -20,6 +20,10 @@
     "lite.js",
     "lite.d.ts"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/cache-browser-local-storage": "4.0.0",
     "@algolia/cache-common": "4.0.0",

diff --git a/packages/cache-browser-local-storage/package.json b/packages/cache-browser-local-storage/package.json
@@ -12,6 +12,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/cache-common": "4.0.0"
   }

diff --git a/packages/cache-common/package.json b/packages/cache-common/package.json
@@ -11,5 +11,9 @@
   "files": [
     "index.js",
     "dist"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-js.git"
+  }
 }
diff --git a/packages/cache-in-memory/package.json b/packages/cache-in-memory/package.json
@@ -12,6 +12,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/cache-common": "4.0.0"
   }

diff --git a/packages/client-account/package.json b/packages/client-account/package.json
@@ -11,6 +11,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/client-common": "4.0.0",
     "@algolia/client-search": "4.0.0",

diff --git a/packages/client-analytics/package.json b/packages/client-analytics/package.json
@@ -11,6 +11,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/client-common": "4.0.0",
     "@algolia/client-search": "4.0.0",

diff --git a/packages/client-common/package.json b/packages/client-common/package.json
@@ -11,6 +11,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/requester-common": "4.0.0",
     "@algolia/transporter": "4.0.0"

diff --git a/packages/client-recommendation/package.json b/packages/client-recommendation/package.json
@@ -11,6 +11,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/client-common": "4.0.0",
     "@algolia/requester-common": "4.0.0",

diff --git a/packages/client-search/package.json b/packages/client-search/package.json
@@ -11,6 +11,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/client-common": "4.0.0",
     "@algolia/requester-common": "4.0.0",

diff --git a/packages/logger-common/package.json b/packages/logger-common/package.json
@@ -11,5 +11,9 @@
   "files": [
     "index.js",
     "dist"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-js.git"
+  }
 }
diff --git a/packages/logger-console/package.json b/packages/logger-console/package.json
@@ -12,6 +12,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/logger-common": "4.0.0"
   }

diff --git a/packages/requester-browser-xhr/package.json b/packages/requester-browser-xhr/package.json
@@ -12,6 +12,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/requester-common": "4.0.0"
   }

diff --git a/packages/requester-common/package.json b/packages/requester-common/package.json
@@ -11,5 +11,9 @@
   "files": [
     "index.js",
     "dist"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-js.git"
+  }
 }
diff --git a/packages/requester-node-http/package.json b/packages/requester-node-http/package.json
@@ -12,6 +12,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/requester-common": "4.0.0"
   }

diff --git a/packages/transporter/package.json b/packages/transporter/package.json
@@ -12,6 +12,10 @@
     "index.js",
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "dependencies": {
     "@algolia/cache-common": "4.0.0",
     "@algolia/logger-common": "4.0.0",