Skip to content

Commit 59776e5

Browse files
committed
Update README
1 parent 66e64df commit 59776e5

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Install and use by directly including the [browser files](dist):
6060
```html
6161
<head>
6262
<title>My A-Frame Scene</title>
63-
<script src="https://aframe.io/releases/1.3.0/aframe.min.js"></script>
63+
<script src="https://aframe.io/releases/1.6.0/aframe.min.js"></script>
6464
<script src="https://unpkg.com/[email protected]/index.js"></script>
6565
</head>
6666

@@ -100,7 +100,28 @@ npm start
100100

101101
This should start a local dev server, go to [http://localhost:3000/](http://localhost:3000/) to inspect the examples. To stop the server, hit `CONTROL-C`.
102102

103-
### Distribution
103+
## Contributing
104+
105+
PRs are welcome. Opening an issue to discuss large changes beforehand is a good idea.
106+
107+
For more information, take a look at [A-Frame's contributing guide](https://github.com/aframevr/aframe/blob/master/CONTRIBUTING.md), specifically the [steps for contributing code](https://github.com/aframevr/aframe/blob/master/CONTRIBUTING.md#contribute-code-to-a-frame).
108+
109+
## Publishing
110+
111+
1. Add a new entry to `./CHANGELOG.md`.
112+
113+
2. Increment `"version"` in `./package.json` following [SEMVER](https://semver.org/).
114+
115+
```bash
116+
# Where <update_type> is one of (patch, major, or minor)
117+
npm version <update_type>
118+
```
119+
120+
3. `npm publish`
121+
122+
4. Update the `unpkg.com/aframe-cubemap-component@VERSION/index.js` link in this README.
123+
124+
### A note about Browserify
104125

105126
Prior to version 3.0.0, this component used a Browserify workflow. This was fine until it prevented upgrading to A-Frame v 1.3.0 which was needed to [resolve a rendering issue](https://github.com/bryik/aframe-cubemap-component/issues/39#issuecomment-1312806990). Since this component has no external dependencies and webpack is annoying to setup, I decided to go for a low-tech solution.
106127

@@ -109,9 +130,3 @@ Users can pin specific versions by altering the unpkg URL:
109130
```
110131
https://unpkg.com/[email protected]/index.js
111132
```
112-
113-
### Contributing
114-
115-
PRs are welcome. Opening an issue to discuss large changes beforehand is a good idea.
116-
117-
For more information, take a look at [A-Frame's contributing guide](https://github.com/aframevr/aframe/blob/master/CONTRIBUTING.md), specifically the [steps for contributing code](https://github.com/aframevr/aframe/blob/master/CONTRIBUTING.md#contribute-code-to-a-frame).

0 commit comments

Comments
 (0)