Skip to content

Commit c5e150d

Browse files
authored
Merge pull request #17 from cyclic-software/scoped-package
Scoped package
2 parents 8acb46f + 826ad46 commit c5e150d

File tree

4 files changed

+6996
-912
lines changed

4 files changed

+6996
-912
lines changed

.npmignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1+
.github
12
examples
2-
test
3+
test

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cyclic-dynamodb
1+
# @cyclic.sh/dynamodb
22

33
NodeJS SDK for interacting with [Cyclic.sh](https://cyclic.sh) app AWS DynamoDB databases.
44

@@ -19,7 +19,7 @@ Together with the Cyclic.sh DynamoDB indexing strategy and data model, the sdk s
1919

2020
1. Install
2121
```
22-
npm install cyclic-dynamodb
22+
npm install @cyclic.sh/dynamodb
2323
```
2424
2. Copy the temporary credentials from the cyclic console and set them in the shell environment where your code will be running.
2525
<p align="center">
@@ -31,15 +31,15 @@ Together with the Cyclic.sh DynamoDB indexing strategy and data model, the sdk s
3131
3. Set the database name as an environment variable before requiring the sdk - this can be added to environment configurations.
3232
```js
3333
process.env.CYCLIC_DB = 'your-url-subdomainCyclicDB'
34-
const db = require('cyclic-dynamodb')
34+
const db = require('@cyclic.sh/dynamodb')
3535
```
3636
----------
3737
3838
# Example
3939
4040
```js
4141
// example.js
42-
const CyclicDB = require('cyclic-dynamodb')
42+
const CyclicDB = require('@cyclic.sh/dynamodb')
4343
const db = CyclicDB('your-table-name')
4444
4545
const run = async function(){

0 commit comments

Comments
 (0)