Skip to content

Commit

Permalink
chore(docs): readme and getting started updated
Browse files Browse the repository at this point in the history
  • Loading branch information
valorkin committed Nov 3, 2017
1 parent af7597b commit 4166bee
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 31 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,20 @@ Or Bootstrap 4
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" rel="stylesheet">
```
To enable bootstrap 4 theme templates in ngx-bootstrap, please read
[here](https://github.com/valor-software/ngx-bootstrap/blob/development/docs/getting-started/bootstrap4.md) .
[this](https://github.com/valor-software/ngx-bootstrap/blob/development/docs/getting-started/bootstrap4.md) .

```
<!-- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
```
# Usage & Demo

Main source of API documentation and usage scenarios available here:
[https://valor-software.com/ngx-bootstrap/](https://valor-software.com/ngx-bootstrap/)

Additionally you can find demos and docs deployed from latest code with <a href="https://ngx-bootstrap.surge.sh/">angular v4</a> and <a
href="https://ngx-bootstrap-latest.surge.sh/">angular v5</a>

Server side rendered version of this documentation available <a href="https://ngx-universal.herokuapp.com/">here</a>

# API
Check demo page for API [reference](https://valor-software.com/ngx-bootstrap/)

## How to use it with:
- `angular-cli` please refer to [getting-started-with-ng-cli](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/ng-cli.md)
Expand All @@ -94,15 +101,6 @@ First time
If you want to run the demo with Angular Universal:
- `npm run demo.serve-universal`


# Usage & Demo

Main source of API documentation and usage scenarios available here:
[http://valor-software.github.io/ngx-bootstrap/](http://valor-software.github.io/ngx-bootstrap/)

# API
Check demo page for API [reference](http://valor-software.github.io/ngx-bootstrap/)

# Troubleshooting

So you are in trouble, where to get help:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,15 @@ <h3>How to use it with:</h3>

<h2 id="usage--demo">Usage & Demo </h2>

<p>Main source of API documentation and usage scenarious available here:
<a href="http://valor-software.github.io/ngx-bootstrap/">http://valor-software.github.io/ngx-bootstrap/</a></p>
<p>Main source of API documentation and usage examples available here:
<a href="https://valor-software.com/ngx-bootstrap/">https://valor-software.com/ngx-bootstrap/</a></p>
<p>Additionally you can find demos and docs deployed from latest code with <a href="https://ngx-bootstrap.surge.sh/">angular v4</a> and <a
href="https://ngx-bootstrap-latest.surge.sh/">angular v5</a></p>
<p>Server side rendered version of this documentation available <a href="https://ngx-universal.herokuapp.com/">here</a></p>

<h2 id="api">API</h2>

<p>Check demo page for API <a href="http://valor-software.github.io/ngx-bootstrap/">reference</a></p>
<p>Check demo page for API <a href="https://valor-software.com/ngx-bootstrap/">reference</a></p>

<h2 id="troubleshooting">Troubleshooting</h2>

Expand Down
15 changes: 1 addition & 14 deletions docs/getting-started/bootstrap4.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The important thing to note is the final section - you must let ngx-bootstrap kn

#### Installing angular-cli

*Important*: please check `angular-cli` version, it should be => "1.0.0-beta.24 (at the time or writing it is at 1.0.0-rc.0)"
*Important*: please check `angular-cli` version, it should be => "1.5.0"

*Note*: You can skip this part if you already have application generated by `ng-cli` and webpack.

Expand Down Expand Up @@ -83,19 +83,6 @@ In `styles.scss` add the following:
@import '../node_modules/bootstrap/scss/bootstrap';
```

### Let ngx-bootstrap know you are using Bootstrap 4

Open `/src/index.html` and add the following markup:

```html
<body>
<!-- Enable bootstrap 4 theme -->
<script>window.__theme = 'bs4';</script>

<app-root> </app-root>
</body>
```

### Testing

Open `src/app/app.module.ts` and add
Expand Down

0 comments on commit 4166bee

Please sign in to comment.