Skip to content

Commit

Permalink
Docs: add links to website. (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
MbIXjkee authored Jul 28, 2024
1 parent fd60a39 commit 4fb93b4
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 87 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Flutter Elementary repository
###
<p align="center">
<img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo">
<a href="https://documentation.elementaryteam.dev/"><img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo"></a>
</p>

###
Expand Down Expand Up @@ -37,6 +37,10 @@ Elementary is a simple and reliable way to build applications with MVVM in Flutt
- **High testability**: All layers, from widgets to business logic, are highly testable.
- **Team efficiency**: It boosts speed for teams consisting of more than one person, due to the easy sharing of independent task parts among team members.

## Documentation

Learn more at our website with [documentation](https://documentation.elementaryteam.dev/").

## Environment

To reduce the amount of boilerplate and manual work, Elementary offers a few options:
Expand Down
4 changes: 2 additions & 2 deletions packages/elementary/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Elementary
###
<p align="center">
<img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo">
<a href="https://documentation.elementaryteam.dev/libs/elementary/intro/"><img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo"></a>
</p>

###
Expand Down Expand Up @@ -52,7 +52,7 @@ A good way to demonstrate the library's functionality without technical details

## Crossroad

If you’re not interested in the technical implementation details or the reasons behind specific decisions, follow this [simple guideline](https://github.com/Elementary-team/flutter-elementary/blob/main/packages/elementary/documentation/quick_start.md) to quickly start using the library.
If you’re not interested in the technical implementation details or the reasons behind specific decisions, follow this [simple guideline](https://documentation.elementaryteam.dev/tutorials/qs/tooling/) to quickly start using the library.

For those interested in the technical details and rationale behind our decisions, welcome to the next section of this documentation.

Expand Down
82 changes: 0 additions & 82 deletions packages/elementary/documentation/quick_start.md

This file was deleted.

2 changes: 1 addition & 1 deletion packages/elementary_helper/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Elementary-helper
###
<p align="center">
<img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo">
<a href="https://documentation.elementaryteam.dev/libs/elementary-helper/intro/"><img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo"></a>
</p>

###
Expand Down
2 changes: 1 addition & 1 deletion packages/elementary_test/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Elementary-test
###
<p align="center">
<img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo">
<a href="https://documentation.elementaryteam.dev/libs/elementary-test/intro/"><img src="https://i.ibb.co/jgkB4ZN/Elementary-Logo.png" alt="Elementary Logo"></a>
</p>

###
Expand Down

0 comments on commit 4fb93b4

Please sign in to comment.