Skip to content

Commit b483685

Browse files
committed
improved Readme's
1 parent d2e209f commit b483685

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,13 +208,19 @@ Please note that several hosting services have policies that does not permit to
208208

209209
Learn more on the [AR.js Official Documentation](https://ar-js-org.github.io/AR.js-Docs/).
210210

211-
## Experimental ES6 npm package
211+
## ES6 npm package
212212

213-
Even if not yet in the master branch, you can install **AR.js** with NPM:
213+
You can install **AR.js** with **npm** and use in any compatible project that support npm modules (React.js, Vue.js, Next.js or whatelse), to install it run:
214214

215215
```
216+
// Install with npm
216217
npm install @ar-js-org/ar.js
217218
```
219+
```
220+
// Install with yarn
221+
yarn add @ar-js-org/ar.js
222+
```
223+
For some examples read this issue
218224
## Troubleshooting, feature requests, community
219225

220226
**You can find a lot of help on the old [AR.js repositories issues](https://github.com/jeromeetienne/AR.js/issues). Please search on open/closed issues, you may find interesting stuff.**

three.js/src/location-based/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,11 @@ This is a simple, lightweight implementation of location-based AR.js using pure
44

55
## Example
66

7-
Provided in the `example` directory is an example. This will behave differently
8-
depending on the query string parameter `m` supplied to it:
9-
10-
- `m` missing or `m=0`: uses a default location and does not setup device orientation controls. Useful for testing on a desktop.
11-
12-
- `m=1` : uses a default location but does setup device orientation controls. Useful for testing on a mobile device. Move the device round and you should see a red box to the northeast, green box to the north and blue box to the west (approximately).
13-
14-
- `m=2` : will use GPS tracking and device orientation controls. Unless you are located near the default location, you will need to modify the `index.js` code to add meshes near your current location.
15-
16-
If `m=1` is used (default location with device orientation controls) you should see the following:
7+
Provided in the `example/location-based` directory is an example. It will check if a Mobile device is in use there are two cases:
8+
- if gps is enabled you will need to modify the `example/location-based/index.js` code to add meshes near your current location.
9+
- if gps is not enabled a fakeGps will start and you will see the four meshes.
10+
11+
In any case, it does setup device orientation controls and you will see the following:
1712

1813
- Red box a short distance to your north
1914
- Green box a short distance to your east

0 commit comments

Comments
 (0)