Skip to content
This repository was archived by the owner on Jul 22, 2024. It is now read-only.

Update README.md #57

Merged
merged 1 commit into from
Aug 8, 2019
Merged

Update README.md #57

merged 1 commit into from
Aug 8, 2019

Conversation

fernandojsg
Copy link
Contributor

@fernandojsg fernandojsg commented Aug 8, 2019

Cleaning the readme to just focus on the important information and move the rest to articles or other wiki pages on the repo if needed

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@@ -1,5 +1,3 @@
Status: In development. [Any feedback is very welcome.](https://github.com/MozillaReality/immersive-custom-elements/issues)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems redundant as people already know that they could just use issues for that, so better remove

@@ -12,18 +10,6 @@ your web page by using custom element tags. It currently includes components for

[Demo](https://rawcdn.githack.com/MozillaReality/immersive-custom-elements/v0.1.0/examples/index.html)

## Background
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could leave this type of explanations for the article instead

@@ -36,7 +22,7 @@ Add the link to `immersive-custom-elements.js` with `<script>` tag. You can down
<script src="https://rawcdn.githack.com/MozillaReality/immersive-custom-elements/v0.1.0/build/immersive-custom-elements.js"></script>
</head>
<body>
<img-360 src="https://rawcdn.githack.com/MozillaReality/immersive-custom-elements/v0.1.0/assets/img-360/landscape-3531355_1920.jpg" width="640" height="360"></img-360>
<img-360 src="360-landscape.jpg" width="640" height="360"></img-360>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just for the sake of making the example shorter, even if the file doesn't exist people could get the sense on how the example looks that is the main point

@@ -45,10 +31,6 @@ Add the link to `immersive-custom-elements.js` with `<script>` tag. You can down

- \<img-360\>
- \<video-360\>
<!-- - \<img-360-tour\> -->
- other new elements coming later
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we will include in the article too that there will be more elements to come if this is successful somehow, also it could be nice to include a roadmap.md with the ideas in there


![GitHub Logo](screenshots/immersive.gif)

## 360 degree photo/video
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again I believe this is better to move to an article, and it could be hard to keep track of new cameras, new recommendations so this will be incomplete, so prefer to remove. Also if we include other elements, like models or so, for consistency we need to create a similar section explaining that, so I prefer to remove also because of that

@@ -159,11 +91,6 @@ $ npm run start
# local server boots up. Access http://localhost:8080/examples/index.html on your browser.
```

## Similar projects
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to make it explicit to avoid comparison

@takahirox takahirox merged commit a74da72 into master Aug 8, 2019
@takahirox
Copy link
Contributor

Looking good, thanks.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants