Skip to content

Commit bd044df

Browse files
Merge pull request #15 from Fullscript/readme-update
Docs(Readme.md): Updated readme to point to fullscript.dev docs
2 parents 740a84a + 3490bdd commit bd044df

2 files changed

Lines changed: 37 additions & 185 deletions

File tree

README.developers.md

Lines changed: 0 additions & 184 deletions
This file was deleted.

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
1-
To access an information packet regarding Fullscript.js please reach out to [integrations@fullscript.com](mailto:integrations@fullscript.com)
1+
# Fullscript.js Documentation
2+
3+
Please visit [the fullscript.js docs](https://fullscript.dev/docs/how-to-guides/fullscript-js/what-is-fullscript-js) to get started.
4+
5+
6+
## Demo
7+
8+
In the project directory, we have two demo apps - React demo and UMD demo that you can experiment with.
9+
10+
### create-react-app demo
11+
12+
The `create-react-app` demo app will use the npm package version of the fullscript-js library. Compared to the CDN version, the npm package version will contain typing information for your IDE and requires a bundler for packaging.
13+
14+
To get things started, please run the following from the root of the project:
15+
16+
1. `yarn link`
17+
2. `yarn install`
18+
3. `yarn build`
19+
20+
Next run the following from the react-demo directory `cd demo/react-demo`:
21+
22+
1. `yarn link fullscript-js`
23+
2. `yarn install`
24+
25+
Next you can run the React app:
26+
27+
- `yarn start` (from inside demo/react-demo)
28+
- `yarn demo:npm` (from the root of the project)
29+
30+
### UMD demo
31+
32+
The UMD version of the fullscript-js library is pre-packaged for consumption by browsers. This does not rely on a bundler such as webpack and can be included via a single script tag in any html file. The downside of this version is that you do no benefit from typing information.
33+
34+
To run the demo, you need simply run the following from the root of the project:
35+
36+
- `yarn install` (from inside demo/javascript-demo/server)
37+
- `yarn demo:umd` (from the root of the project)

0 commit comments

Comments
 (0)