Skip to content

Commit 7d88b72

Browse files
fix: Fixing README.md and adding license
1 parent acaf0f1 commit 7d88b72

File tree

2 files changed

+37
-4
lines changed

2 files changed

+37
-4
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025, Glean Technologies Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,24 @@ Each namespace has its own authentication requirements and access patterns. Whil
1313

1414
```typescript
1515
// Example of accessing Client namespace
16-
const glean = new Glean({ apiToken: "client-token" });
17-
await glean.client.search.query({ query: "search term" });
16+
const glean = new Glean({
17+
instance: 'instance-name',
18+
apiToken: 'client-token'
19+
});
20+
21+
await glean.client.search.query({
22+
query: 'search term'
23+
});
1824

1925
// Example of accessing Indexing namespace
20-
const glean = new Glean({ apiToken: "indexing-token" });
21-
await glean.indexing.documents.index({ /* document data */ });
26+
const glean = new Glean({
27+
instance: 'instance-name',
28+
apiToken: 'indexing-token'
29+
});
30+
31+
await glean.indexing.documents.index({
32+
/* document data */
33+
});
2234
```
2335

2436
Remember that each namespace requires its own authentication token type as described in the [Authentication Methods](#authentication-methods) section.

0 commit comments

Comments
 (0)