Skip to content

Commit

Permalink
Merge pull request #63 from notafk-rajat/wsl-note
Browse files Browse the repository at this point in the history
Added a note for WSL2 users
  • Loading branch information
qascade authored Oct 14, 2022
2 parents 9b97d42 + b6464de commit c6b4217
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Use "yast [command] --help" for more information about a command.
## 📝 NOTE
1. The current supported target requires VPN to get results. Please make sure that you are connected to a **VPN Server** before searching or you may not get the results. We personally recommend using CloudFlare Warp. You can [download](https://1.1.1.1/) it here.
2. The Project is still in development stage. So, you might see undesired behaviour while using yast. Please file an issue if you experience any bugs or undesired behaviour.
3. yast does not support WSL2, because the current targets available in yast, only work with VPN and it's very difficult to establish a VPN connection on WSL2.


## 🤝 Contribution
Expand All @@ -79,3 +80,17 @@ Use "yast [command] --help" for more information about a command.
3. Look at [CONTRIBUTION.md](https://github.com/qascade/yast/blob/main/CONTRIBUTION.md) for more details.
4. Read and Follow the [CODE_OF_CONDUCT](https://github.com/qascade/yast/blob/main/CODE_OF_CONDUCT.md).

## System Design

### Design Docs

[**Structure Design**](https://docs.google.com/document/d/1UHGnfGrgGyRTDN-Pku7QamPtbvk5Bin9dBn7n1JDMv8/edit?usp=sharing)

[**Command Design**](https://docs.google.com/document/d/1RfgyEZspIOFJCn0b4ZE0ZEXBEAOYSrPeA1itbRKs1sI/edit?usp=sharing)

[**UI Design**](https://docs.google.com/document/d/1kt_9C1enPmliXcqxuFt19Td4XH5Tn8wnns4vdDrsM0E/edit?usp=sharing)

### Design Diagrams
<img width="600" alt="Screenshot 2022-08-13 at 1 22 09 PM" src="https://user-images.githubusercontent.com/54154054/184474748-13b1f7bf-5af9-4f43-a9d9-bf8f40507d40.png">

<img width="801" alt="Screenshot 2022-08-25 at 5 21 11 AM" src="https://user-images.githubusercontent.com/54154054/186544174-165896ac-ee39-4c10-993c-f8fdf47e7ed3.png">
File renamed without changes.

0 comments on commit c6b4217

Please sign in to comment.