Skip to content

Commit ecdf2b3

Browse files
authored
Emojis in README for better table of contents
1 parent 8b056cb commit ecdf2b3

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# WebXR Export
1+
# WebXR Export
22

33
You can [check the live demo here](https://de-panther.github.io/unity-webxr-export).
44

@@ -14,32 +14,32 @@ It integrates the WebXR JavaScript API to [Unity WebGL](https://docs.unity3d.com
1414

1515
<hr>
1616

17-
## Downloads
17+
## 💾 Downloads
1818

1919
Better option: Import WebXR Export and WebXR Interactions packages from OpenUPM.
2020
- [WebXR Export ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr/)
2121
- [WebXR Interactions ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr-interactions?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr-interactions/)
2222

2323
Or import the packages from git, more info at [WebXR Export](Packages/webxr/README.md) and [WebXR Interactions](Packages/webxr-interactions/README.md).
2424

25-
## Documentation
25+
## 📄 Documentation
2626

2727
For more info on getting started and how to use WebXR Export, you can check the [Documentation](Documentation) folder.
2828

29-
## Compatibility
29+
## 🧩 Compatibility
3030

3131
**Important notice** regarding this Git repository - This repository use Symlinks. make sure that Symlinks are enabled when you clone.
3232

3333
`git config core.symlinks true`
3434

3535
Or just use this as a Unity Package (UPM), more info [here](Packages/webxr/README.md)
3636

37-
### Unity Editor version
37+
### 📝 Unity Editor version
3838

3939
* `2019.4.7` and up.
4040
* `2020.1` and up.
4141

42-
### Browser Compatibility
42+
### 🗺️ Browser Compatibility
4343

4444
This is a list of browsers and platforms that the WebXR Export demo was tested on.
4545

@@ -63,13 +63,13 @@ Samsung Internet Browser on Android (Supports both AR and VR sessions).
6363

6464
Firefox Reality on Vive Focus Plus.
6565

66-
#### Has bugs/issues
66+
#### 🐞 Has bugs/issues
6767

6868
Mozilla WebXR Viewer on iOS (Has a bug related to touch input).
6969

7070
Helio on Magic Leap One (Has a bug related to eye views).
7171

72-
### WebXR APIs support
72+
### ⚙️ WebXR APIs support
7373

7474
[WebXR Device API](https://immersive-web.github.io/webxr/)
7575

@@ -85,23 +85,23 @@ Helio on Magic Leap One (Has a bug related to eye views).
8585

8686
![Hands](/Documentation/webxr-hands-api.gif)
8787

88-
### Polyfilled WebXR / WebVR
88+
### 📊 Polyfilled WebXR / WebVR
8989

9090
If the user does not have supported headset, browser or device, the content will still work through the use of the [WebXR Polyfill](https://github.com/immersive-web/webxr-polyfill).
9191

92-
### Mobile support
92+
### 📱 Mobile support
9393

9494
This asset works by utilizing Unity's WebGL platform support and therefore shares the same limitations. Because of this, mobile support is limited and may not work. We did made sure to make it light, so mobile devices would be able to handle it, and it is able to run on high end mobile devices with some optimizations. See [Unity's WebGL browser compatibility](https://docs.unity3d.com/2019.3/Documentation/Manual/webgl-browsercompatibility.html).
9595

96-
### Version History and Notes
96+
### 📜 Version History and Notes
9797

9898
You can check the changelogs of [WebXR Export](Packages/webxr/CHANGELOG.md) and [WebXR Interactions](Packages/webxr-interactions/CHANGELOG.md) for version history.
9999

100-
## Contributing
100+
## 🤝 Contributing
101101

102102
You're encouraged to [open an issue](https://github.com/De-Panther/unity-webxr-export/issues/new), report a problem, contribute with code, open a feature request, share your work or ask a question. But remember that it's an experimental project.
103103

104-
## Useful links and info
104+
## 🔗 Useful links and info
105105

106106
Much of the WebXR upgrades and API usage made possible thanks to these resources.
107107

@@ -121,7 +121,7 @@ Much of the WebXR upgrades and API usage made possible thanks to these resources
121121

122122
[WebXR Discord](https://discord.gg/Jt5tfaM)
123123

124-
## Credits
124+
## 🎞️ Credits
125125

126126
Special thanks to [needle.tools](https://needle.tools/) for the help in making this a proper package.
127127

@@ -133,7 +133,7 @@ This project was heavily influenced by early explorations in using Unity to buil
133133

134134
Also, thanks to [Arturo Paracuellos (@arturitu)](https://github.com/arturitu) for creating the [3D-hand models](https://github.com/aframevr/assets/tree/gh-pages/controllers/hands) used for controllers in these examples.
135135

136-
## License
136+
## ⚖️ License
137137

138138
As the base project used the Apache License, Version 2.0, we will continue with it.
139139

0 commit comments

Comments
 (0)