Skip to content

Commit f50672d

Browse files
Update README.md
1 parent c57e716 commit f50672d

File tree

1 file changed

+3
-38
lines changed

1 file changed

+3
-38
lines changed

README.md

Lines changed: 3 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# Anduril TypeScript Library
1+
# Lattice SDK TypeScript Library
22

33
![](https://www.anduril.com/lattice-sdk/)
44

5-
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fanduril%2Flattice-sdk-javascript)
6-
[![npm shield](https://img.shields.io/npm/v/@anduril-industries/lattice-sdk)](https://www.npmjs.com/package/@anduril-industries/lattice-sdk)
7-
8-
The Anduril TypeScript library provides convenient access to the Anduril API from TypeScript.
5+
The Lattice SDK TypeScript library provides convenient access to the Lattice API from TypeScript.
96

107
## Documentation
118

@@ -25,7 +22,7 @@ npm i -s @anduril-industries/lattice-sdk
2522

2623
## Support
2724

28-
For support with this library please reach out to your Anduril representative.
25+
For support with this library, please reach out to your Anduril representative.
2926

3027
## Reference
3128

@@ -537,18 +534,6 @@ while (page.hasNextPage()) {
537534

538535
## Advanced
539536

540-
### Additional Headers
541-
542-
If you would like to send additional headers as part of the request, use the `headers` request option.
543-
544-
```typescript
545-
const response = await client.entities.longPollEntityEvents(..., {
546-
headers: {
547-
'X-Custom-Header': 'custom value'
548-
}
549-
});
550-
```
551-
552537
### Retries
553538

554539
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
@@ -569,16 +554,6 @@ const response = await client.entities.longPollEntityEvents(..., {
569554
});
570555
```
571556

572-
### Timeouts
573-
574-
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
575-
576-
```typescript
577-
const response = await client.entities.longPollEntityEvents(..., {
578-
timeoutInSeconds: 30 // override timeout to 30s
579-
});
580-
```
581-
582557
### Aborting Requests
583558

584559
The SDK allows users to abort requests at any point by passing in an abort signal.
@@ -627,13 +602,3 @@ const client = new LatticeClient({
627602
fetcher: // provide your implementation here
628603
});
629604
```
630-
631-
## Contributing
632-
633-
While we value open-source contributions to this SDK, this library is generated programmatically.
634-
Additions made directly to this library would have to be moved over to our generation code,
635-
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
636-
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
637-
an issue first to discuss with us!
638-
639-
On the other hand, contributions to the README are always very welcome!

0 commit comments

Comments
 (0)