Skip to content

Commit

Permalink
docs: remove dated language and move towards toolkit language (#2031)
Browse files Browse the repository at this point in the history
  • Loading branch information
moonmeister authored Jan 22, 2025
1 parent 8f133f5 commit 2d884b5
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 9 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,10 @@

## Introduction

Faust.js is a framework for building front-end applications for headless WordPress sites. Faust.js provides tooling to reduce the pains of building a headless WordPress site (namely around data fetching, authentication, previews, and SSR/SSG) while offering a pleasant experience for both developers and publishers.

## Getting Started

Faust.js aims to be framework agnostic, so it can be used with any front-end framework. Visit one of the guides below for a starting point:
Faust.js is a toolkit for building Next.js applications for headless WordPress sites. Faust.js provides tooling to reduce the pains of building a headless WordPress site (namely around data fetching, authentication, previews, and SSR/SSG) while offering a pleasant experience for both developers and publishers.

- [Getting started with Next.js](https://faustjs.org/docs/getting-started)

As we work towards our first release, we will be introducing support for other frameworks.

## System Requirements

- Node.js v16.0.0 or newer (v16.8.0 when using Next.js 13 and v18.17 when using Next.js 14).
Expand Down
2 changes: 1 addition & 1 deletion packages/faustwp-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@
</a>
</p>

`@faustwp/cli` provides a CLI to develop, build, and serve your Faust apps.
`@faustwp/cli` provides a CLI to develop, build, and serve your Next.js apps built with Faust.js.
2 changes: 1 addition & 1 deletion packages/faustwp-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@
</a>
</p>

Faust is a framework that aims to make headless WordPress as streamlined as classic WordPress for both developers and publishers.
Faust is a toolkit that aims to make headless WordPress as streamlined as classic WordPress for both developers and publishers.

0 comments on commit 2d884b5

Please sign in to comment.