Skip to content

Commit 9eb5f62

Browse files
authored
Merge pull request #25 from cyclic-software/text-edits
remove preview language, small text changes
2 parents ab7dd49 + dc0c621 commit 9eb5f62

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ NodeJS SDK for interacting with [Cyclic.sh](https://cyclic.sh) app AWS DynamoDB
88

99

1010

11-
Together with the Cyclic.sh DynamoDB indexing strategy and data model, the sdk simplifies the DynamoDB interface and enables collection organization of records, queries and data scheme discovery among other features.
11+
Together with the Cyclic.sh DynamoDB indexing strategy and data model, the SDK simplifies the DynamoDB interface and enables collection organization of records, queries, and data scheme discovery, among other features.
1212

13-
> The sdk and database feature are in preview - use it with the assumption that the interface and data structures will change. We use semantic release for versioning so take note of version numbers.
13+
> We use semantic release for versioning so take note of version numbers.
1414
1515
## Prerequisites
1616

17-
- A cyclic app with database enabled
18-
- Databases are in preview - request access on Discord >> https://discord.gg/huhcqxXCbE
17+
- A Cyclic.sh app with database enabled
1918
- For use on local:
2019
- AWS credentials set in environment (available on an app's database tab)
2120

@@ -25,14 +24,14 @@ Together with the Cyclic.sh DynamoDB indexing strategy and data model, the sdk s
2524
```
2625
npm install @cyclic.sh/dynamodb
2726
```
28-
2. Copy the temporary credentials from the cyclic console and set them in the shell environment where your code will be running.
27+
2. Copy the temporary credentials from the Cyclic.sh console and set them in the shell environment where your code is running.
2928
<p align="center">
3029
<img src="https://github.com/cyclic-software/db-sdk/blob/main/examples/console.png?raw=true" width="500"/>
3130
</p>
3231
3332
> Credentials are required only for connecting to the database from local and expire after one hour, don't add them to an environment configuration.
3433
35-
3. Set the database name as an environment variable before requiring the sdk - this can be added to environment configurations.
34+
3. Set the database name as an environment variable before requiring the SDK - this can be added to environment configurations.
3635
```js
3736
process.env.CYCLIC_DB = 'your-url-subdomainCyclicDB'
3837
const db = require('@cyclic.sh/dynamodb')
@@ -80,7 +79,7 @@ run()
8079
```
8180

8281
# Fragments
83-
With the cyclic.sh data model, items can have `fragments`. These can be thought of as **children or attachments** to items.
82+
With the Cyclic.sh data model, items can have `fragments`. These can be thought of as **children or attachments** to items.
8483

8584
Another way to think of fragments is by thinking of an item itself as its own collection of other items that are stored closely together.
8685

@@ -105,11 +104,11 @@ let mikes_work = await users.item('mike').fragment('work').get()
105104

106105
```
107106

108-
# TTL - time to live
107+
# TTL - Time To Live
109108

110-
You optionally may set a TTL for any item. The `ttl` is the UNIX seconds timestamp when the item should expire.
109+
You optionally may set a TTL for any item. The `TTL` is the UNIX seconds timestamp when the item should expire.
111110

112-
The ttl setting passes through to the [DynamoDB ttl](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) setting. The expiration is only approximate within a few minutes.
111+
The TTL setting passes through to the [DynamoDB TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) setting. The expiration is only approximate within a few minutes.
113112

114113
## Example
115114

0 commit comments

Comments
 (0)