Skip to content

Commit

Permalink
Update READMEs add .github files
Browse files Browse the repository at this point in the history
  • Loading branch information
donald-stolz committed Feb 4, 2020
1 parent 02166ab commit b44ce2a
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 17 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: ""
---

**Describe the bug** A clear and concise description of what the bug is.

**To Reproduce** Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior** A clear and concise description of what you expected to
happen.

**Screenshots** If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context** Add any other context about the problem here.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: ""
---

**Is your feature request related to a problem? Please describe.** A clear and
concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like** A clear and concise description of what you
want to happen.

**Describe alternatives you've considered** A clear and concise description of
any alternative solutions or features you've considered.

**Additional context** Add any other context or screenshots about the feature
request here.
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Change-log

\*\*\* Remove any sections that are not relevant to this PR \*\*\*

## Contribution type

- [ ] Template contribution
- [ ] Existing template update
- [ ] Issue fix
- [ ] README.md update

## Contribution Description

## File Updates
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# Basics for Decentralized Websites
<p align="center">
<a href="https://unstoppabledomains.com/">
<img src="unstoppable-logo.svg" width="300" />
</a>
</p>
<h1 align="center">
Basics for Decentralized Websites
</h1>

Repository for sharing templates and decentralized website info
**Repository for sharing templates and decentralized website info**

## Deploy an IPFS site

1. Checkout the [examples](examples/README.md) to find and update a template that you like.
2. Once you've finished with your site, you can deploy to pinata by using our deploy script or another IPFS tool like (ipfs-deploy)[https://github.com/ipfs-shipyard/ipfs-deploy]
3. Once you've gotten your IPFS hash attach it to your domain
2. Once you've finished with your site, you can deploy to [pinata](https://pinata.cloud/) by using our deploy script or another IPFS tool like [ipfs-deploy](https://github.com/ipfs-shipyard/ipfs-deploy)
3. Once you've gotten your IPFS hash [attach it to your domain](https://youtu.be/I9vTeAtELOk?t=61)
4. Find your site on [ViewBlock](https://viewblock.io/) or check it out in our [demo browser](https://unstoppabledomains.com/browser)

## TODOs
## Contributing

- [ ] Make sure html files are up to date
- [ ] PR template
- [ ] Issues template
We'd love to make your templates available on Unstoppable Domains' website builder. To add a new template simply fork this repo add your templates into [examples/community](examples/community) and submit a PR for your update.

## Contributing
## Additional Articles & Resources

We'd love to make your templates available on Unstoppable Domains' website builder
<!-- TODO -->

## ReadMe TODOs
### Repo TODOs

- [ ] how to contribute
- [ ] link to community page about adding to domain
- [ ] Pinata ref
- [ ] UD ref
[ ] Make sure html files are up to date
[ ] improve how to contributing description
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ In the `ud-static-templates` directory you will find all of the templates availa

**Notes**

- They inline CSS and styles are the options available to update in
- SVG Icons are inlined so that colors can be updated
-

## JS Frameworks
## Using JS Frameworks

Hosting a website on IPFS is slightly different than hosting it on a web server out in the cloud. Your website may require a little bit of tweaking in order to properly be served on the IPFS network.
The important rules are:
Expand Down
5 changes: 5 additions & 0 deletions examples/community/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# IPFS Community Templates

| Author | Template | Available In Builder (y/n) |
| ------ | -------- | -------------------------- |
| | | |
1 change: 1 addition & 0 deletions unstoppable-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b44ce2a

Please sign in to comment.