framer-api 0.0.1-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.d.ts +4604 -0
- package/dist/index.js +14 -0
- package/package.json +60 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
## Usage
|
|
2
|
+
|
|
3
|
+
```typescript
|
|
4
|
+
import { connect } from "framer-api";
|
|
5
|
+
|
|
6
|
+
const project = await connect("bbb", "ap123");
|
|
7
|
+
|
|
8
|
+
const projectInfo = await project.getProjectInfo();
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Publishing
|
|
12
|
+
|
|
13
|
+
Before publishing, you need to adjust the version in `package.json` to a new alpha version, e.g. `0.0.1-alpha.1`. You're yourself responible for picking the right version. Stick to SemVer.
|
|
14
|
+
|
|
15
|
+
Only publish the package once the version landed on the default branch.
|
|
16
|
+
|
|
17
|
+
Release a new alpha version to npm:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
make publish
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
This will:
|
|
24
|
+
- Build the package
|
|
25
|
+
- Publish the changes
|