Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove dated language and move towards toolkit language #2031

Merged
merged 1 commit into from
Jan 22, 2025
Merged

docs: remove dated language and move towards toolkit language #2031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.