Skip to content

Commit

Permalink
docs(README): adjust the readme and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelGSS committed Oct 14, 2020
1 parent f353d21 commit 25fae50
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 23 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
node_modules
dist
.cache
tags
56 changes: 34 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,49 @@
## Welcome to GitHub Pages
<h1 align="center">Welcome to gonzaga-access.github.io 👋</h1>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
<a href="https://github.com/GonzagaAccess/gonzaga-accesshub.io.git#readme" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="https://github.com/GonzagaAccess/gonzaga-accesshub.io.git/graphs/commit-activity" target="_blank">
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
</a>
<a href="https://github.com/GonzagaAccess/gonzaga-accesshub.io.git/blob/master/LICENSE" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/github/license/GonzagaAccess/gonzaga-access.github.io" />
</a>
</p>

You can use the [editor on GitHub](https://github.com/GonzagaAccess/gonzaga-access.github.io/edit/master/README.md) to maintain and preview the content for your website in Markdown files.
> You can use the [editor on GitHub](https://github.com/GonzagaAccess/gonzaga-access.github.io/edit/master/README.md) to maintain and preview the content for your website in Markdown files.
Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
### 🏠 [Homepage](https://github.com/GonzagaAccess/gonzaga-access.github.io#readme)

### Markdown
This project is a website dedicated to be a place where we share all projects with the world.

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
_Note: This website is under development and the informations on it is not fully consistent_

```markdown
Syntax highlighted code block
## Install

# Header 1
## Header 2
### Header 3
```sh
npm install
```

## Running

- Bulleted
- List
```sh
npm run dev
```

1. Numbered
2. List
## Author

**Bold** and _Italic_ and `Code` text
* Github: [@GonzagaAccess](https://github.com/GonzagaAccess)

[Link](url) and ![Image](src)
```
## 🤝 Contributing

For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/GonzagaAccess/gonzaga-access.github.io/issues).

### Jekyll Themes
## Show your support

Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/GonzagaAccess/gonzaga-access.github.io/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
Give a ⭐️ if this project helped you!

### Support or Contact
## 📝 License

Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.
This project is [MIT](https://github.com/GonzagaAccess/gonzaga-accesshub.io.git/blob/master/LICENSE) licensed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"keywords": [],
"author": "",
"license": "ISC",
"license": "MIT",
"bugs": {
"url": "https://github.com/GonzagaAccess/gonzaga-access.github.io/issues"
},
Expand Down

0 comments on commit 25fae50

Please sign in to comment.