Update README.md

This commit is contained in:
Muslem Rahimi 2024-05-26 14:24:59 +02:00 committed by GitHub
parent e0708ed4d1
commit 5cb10a194f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,2 +1,40 @@
# frontend
UI of stocknear
<div align="center">
# **Open Source Stock Analysis & Community Platform for Small Investors.**
<h3>
[Homepage](https://stocknear.com/) | [Discord](https://discord.com/invite/hCwZMMZ2MT)
</h3>
[![GitHub Repo stars](https://img.shields.io/github/stars/stocknear/frontend)](https://github.com/stocknear/frontend/stargazers)
</div>
# Techstack
This is the codebase that powers [stocknear's](https://stocknear.com/) frontend, which is an open-source stock analysis & community platform.
Built with:
- [Sveltekit](https://kit.svelte.dev/): Frontend
- [Tailwindcss](https://tailwindcss.com/): Styling
- [DaisyUI](https://daisyui.com/): Styling
# Getting started
Coming soon to run stocknear locally on your machine.
# Contributing
Stocknear is open-source software and you're welcome to contribute to its development.
# License
Copyright (c) 2024, stocknear
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.