mirror of
https://github.com/actix/actix-website
synced 2024-11-23 16:31:08 +01:00
remove v2 note from readme
This commit is contained in:
parent
9827030543
commit
8ea575194e
18
README.md
18
README.md
@ -1,10 +1,8 @@
|
|||||||
# Actix Website
|
# Actix Website
|
||||||
|
|
||||||
> The upcoming v2 website is available here: <https://actix-website.netlify.app>.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Building the website depends on [Docusaurus], you must have `npm` or `yarn` installed. You can run the site locally with:
|
Building the website depends on [Docusaurus][docusaurus], you must have `npm` or `yarn` installed. You can run the site locally with:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/actix/actix-website.git
|
git clone https://github.com/actix/actix-website.git
|
||||||
@ -17,7 +15,7 @@ Then visit http://localhost:3000.
|
|||||||
|
|
||||||
## Updating diagrams
|
## Updating diagrams
|
||||||
|
|
||||||
Diagrams are located under [/static/img/diagrams/](https://github.com/actix/actix-website/tree/master/static/img/diagrams) and built with [Mermaid CLI][mermaid cli].
|
Diagrams are located under [/static/img/diagrams/](https://github.com/actix/actix-website/tree/master/static/img/diagrams) and built with [Mermaid CLI][mermaid_cli].
|
||||||
|
|
||||||
For instance to edit `connection_overview` diagram:
|
For instance to edit `connection_overview` diagram:
|
||||||
|
|
||||||
@ -28,16 +26,14 @@ vi connection_overview.mmd
|
|||||||
mmdc -i connection_overview.mmd -o connection_overview.svg
|
mmdc -i connection_overview.mmd -o connection_overview.svg
|
||||||
```
|
```
|
||||||
|
|
||||||
# License
|
## License
|
||||||
|
|
||||||
This site is licensed under either of
|
This site is licensed under either of
|
||||||
|
|
||||||
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0])
|
||||||
[http://www.apache.org/licenses/LICENSE-2.0])
|
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT])
|
||||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
||||||
[http://opensource.org/licenses/MIT])
|
|
||||||
|
|
||||||
<!-- LINKS -->
|
<!-- LINKS -->
|
||||||
|
|
||||||
[Docusaurus]: https://docusaurus.io/
|
[docusaurus]: https://docusaurus.io/
|
||||||
[mermaid cli]: https://github.com/mermaidjs/mermaid.cli
|
[mermaid_cli]: https://github.com/mermaidjs/mermaid.cli
|
||||||
|
Loading…
Reference in New Issue
Block a user