Skip to content

Commit

Permalink
updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Anton Horn committed Jun 10, 2020
1 parent ab7cf2b commit c2194af
Showing 1 changed file with 86 additions and 77 deletions.
163 changes: 86 additions & 77 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A single page application displaying github user information (based on react-redux).

### [Demo](https://frontant.github.io/github-resume-demo/)
### [Demo](https://frontant.github.io/demo-sites/github-resume/)

### How to build the project

Expand All @@ -18,7 +18,7 @@ A single page application displaying github user information (based on react-red
gulp build.production

# run the built-in server to preview the website
# or open the "./build/index.html" in your browser
# or open the "./build/index.html" in your browser
gulp watch
```

Expand All @@ -27,7 +27,6 @@ A single page application displaying github user information (based on react-red
- source folder: **./app**
- build folder: **./build**


### Model

```javascript
Expand Down Expand Up @@ -82,91 +81,101 @@ A single page application displaying github user information (based on react-red

```html
<section>
<header>
<h1>
Github Resumé
</h1>
</header>

<section>
<form>
<fieldset>

<label>
Enter your GitHub username and click "generate".
</label>

<label class="error-message"></label>
<header>
<h1>
Github Resumé
</h1>
</header>

<p>
<input type="text" placeholder="Enter your GitHub username" />
<section>
<form>
<fieldset>
<label>
Enter your GitHub username and click "generate".
</label>

<input type="submit" value="generate"/>
</p>
<label class="error-message"></label>

</fieldset>
</form>
</section>

<footer>
<p>
This app shows <b>maximum 5 repositories</b> in order to reduce
number of requests to the GitHub API. <a href="https://developer.github.com/v3/#rate-limiting" target="_blank">Here</a> you can read
more about limitations of the API.
<input type="text" placeholder="Enter your GitHub username" />

<input type="submit" value="generate" />
</p>
</footer>
</fieldset>
</form>
</section>

<footer>
<p>
This app shows <b>maximum 5 repositories</b> in order to reduce number of
requests to the GitHub API.
<a href="https://developer.github.com/v3/#rate-limiting" target="_blank"
>Here</a
>
you can read more about limitations of the API.
</p>
</footer>
</section>
```

### Resume

```html
<section>
<header class="user">
<h1 class="user__name">
Michael Popesko
</h1>

<h2 class="user__description">
Developer
</h2>
</header>

<section>
<div>
<h3>Repositories</h3>
<ul>
<li class="repository">
<span class="error-message"></span>
<h4 class="repository__name">
<a href="https://friend.github.com/html5-template" target="_blank">html5-template</a>
</h4>
<h5 class="repository__description">html5 template</h5>
<div class="repository__languages">
CSS, Html, Javascript
</div>
</li>
<li class="repository">
<span class="error-message"></span>
<h4 class="repository__name">
<a href="https://friend.github.com/wordpress-template" target="_blank">wordpress-template</a>
</h4>
<h5 class="repository__description">wordpress template</h5>
<div class="repository__languages">
CSS, Javascript, PHP
</div>
</li>
</ul>
<a href="#">back</a>
</div>
</section>

<footer>
<p>
This app shows <b>maximum 5 repositories</b> in order to reduce
number of requests to the GitHub API. <a href="https://developer.github.com/v3/#rate-limiting" target="_blank">Here</a> you can read
more about limitations of the API.
</p>
</footer>
<header class="user">
<h1 class="user__name">
Michael Popesko
</h1>

<h2 class="user__description">
Developer
</h2>
</header>

<section>
<div>
<h3>Repositories</h3>
<ul>
<li class="repository">
<span class="error-message"></span>
<h4 class="repository__name">
<a href="https://friend.github.com/html5-template" target="_blank"
>html5-template</a
>
</h4>
<h5 class="repository__description">html5 template</h5>
<div class="repository__languages">
CSS, Html, Javascript
</div>
</li>
<li class="repository">
<span class="error-message"></span>
<h4 class="repository__name">
<a
href="https://friend.github.com/wordpress-template"
target="_blank"
>wordpress-template</a
>
</h4>
<h5 class="repository__description">wordpress template</h5>
<div class="repository__languages">
CSS, Javascript, PHP
</div>
</li>
</ul>
<a href="#">back</a>
</div>
</section>

<footer>
<p>
This app shows <b>maximum 5 repositories</b> in order to reduce number of
requests to the GitHub API.
<a href="https://developer.github.com/v3/#rate-limiting" target="_blank"
>Here</a
>
you can read more about limitations of the API.
</p>
</footer>
</section>
```

0 comments on commit c2194af

Please sign in to comment.