Skip to content

Commit

Permalink
docs: refine README docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ixahmedxi committed Apr 9, 2024
1 parent d03b762 commit 83b0ef0
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
![OrbitKit](https://github.com/ixahmedxi/orbitkit/blob/main/apps/marketing/public/blog-placeholder.jpg?raw=true)

## Note

> [!IMPORTANT]
> OrbitKit is built on top of a very opinionated tech stack, which might not work for every use case/business idea. I offer monorepo architecture consulting or even building something completely custom for you, if you are interested be sure to [DM me on X/Twitter](https://twitter.com/ixahmedxii).
<div align="center">
<img src="https://github.com/ixahmedxi/orbitkit/blob/main/apps/marketing/public/blog-placeholder.jpg?raw=true" alt="Cover image" width="700px">
</div>

## Features

Expand All @@ -30,6 +27,11 @@

And much more!

## Note

> [!IMPORTANT]
> OrbitKit is built on top of a very opinionated tech stack, which might not work for every use case/business idea. I offer monorepo architecture consulting or even building something completely custom for you, if you are interested be sure to [DM me on X/Twitter](https://twitter.com/ixahmedxii).
## Todos

OrbitKit is not in final form yet, there are many things in the plans for it but it is in a usable primitive state. Checkout the [Roadmap](https://github.com/users/ixahmedxi/projects/6) for more info.
Expand Down

0 comments on commit 83b0ef0

Please sign in to comment.