Skip to content
This repository was archived by the owner on Apr 7, 2024. It is now read-only.

Commit

Permalink
Add some docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
NicHaley committed Jan 25, 2024
1 parent fae022b commit 177e9b4
Showing 1 changed file with 43 additions and 5 deletions.
48 changes: 43 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,50 @@
# Floe
> ✨ Coming Soon ✨
<p align="center" style="margin-top: 120px">

Floe is an AI writing assistant. Add it to your CICD pipeline to automatically write new docs and update existing ones. Plus, use AI prose linting to keep your docs consistent and on-brand.
<h3 align="center">Floe</h3>

<p align="center">
AI writing assistants for docs and changelogs.
<br />
<a href="https://floe.dev"><strong>Learn more »</strong></a>
<br />
<br />
<a href="https://join.slack.com/t/floedev/shared_invite/zt-1okoncyuu-_v9KaY7AjEQfKNj6O6qvVg">Slack<a>
·
<a href="https://floe.dev">Website</a>
·
<a href="https://github.com/Floe-dev/floe/issues">Issues</a>
</p>
</p>

# Floe

> ✨ Now in open beta! ✨
Floe is an AI writing assistant for your CLI / CI. Floe can help you to ship technical content, like docs and changelogs, with higher quality and less effort.

Floe ships with two core features:

- **Reviews**: Write your own rules, in plain English, to check your content for a variety of issues. Floe will automatically review your content and provide feedback.

- **First Draft**: Floe can generate a first draft of your content, based on PR context and templates you control.

## Built-with

- [Next.js](https://nextjs.org/)
- [React.js](https://reactjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Prisma.io](https://prisma.io/)
- [Turborepo](https://turbo.build/repo/)
- [NextAuth](https://next-auth.js.org/)

## Getting started

What are you doing in this

[↗️ Website](https://www.floe.dev/)

## Contact us

[📅 Book a demo](https://cal.com/nic-haley/book-a-demo)

[📨 Contact](mailto:[email protected])


0 comments on commit 177e9b4

Please sign in to comment.