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

adding readme buttons for downloads #399

Merged
merged 1 commit into from
Aug 16, 2021
Merged

adding readme buttons for downloads #399

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
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<p align="center">
<strong>NOTE: This is prerelease software. As we work towards our first release, we will 💯 introduce breaking changes.</strong>
<strong>
NOTE: This is prerelease software. As we work towards our first release, we
will 💯 introduce breaking changes.
</strong>
</p>

<p align="center">
Expand All @@ -16,7 +19,20 @@
<a aria-label="License" href="https://github.com/wpengine/headless-framework/blob/canary/LICENSE">
<img alt="" src="https://img.shields.io/npm/l/@faustjs/core?color=7e5cef&style=for-the-badge">
</a>
</p>

<p align="center">
<a aria-label="Faust.js Core Downloads" href="https://www.npmjs.com/package/@faustjs/core">
<img alt="" src="https://img.shields.io/npm/dw/@faustjs/core?color=7e5cef&style=for-the-badge&label=@faustjs/core">
</a>
<!-- -->
<a aria-label="Faust.js Downloads" href="https://www.npmjs.com/package/@faustjs/react">
<img alt="" src="https://img.shields.io/npm/dw/@faustjs/react?color=7e5cef&style=for-the-badge&label=@faustjs/react">
</a>

<a aria-label="Faust.js Downloads" href="https://www.npmjs.com/package/@faustjs/next">
<img alt="" src="https://img.shields.io/npm/dw/@faustjs/next?color=7e5cef&style=for-the-badge&label=@faustjs/next">
</a>
</p>

## Introduction
Expand Down
26 changes: 23 additions & 3 deletions packages/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
# WordPress Headless Framework
# @faustjs/core

[![Version](https://img.shields.io/npm/v/@wpengine/headless.svg)](https://npmjs.org/package/@wpengine/headless)
<p align="center">
<a aria-label="NPM version" href="https://www.npmjs.com/package/@faustjs/core">
<img alt="" src="https://img.shields.io/npm/v/@faustjs/core?color=7e5cef&style=for-the-badge">
</a>

<a aria-label="License" href="https://github.com/wpengine/headless-framework/blob/canary/LICENSE">
<img alt="" src="https://img.shields.io/npm/l/@faustjs/core?color=7e5cef&style=for-the-badge">
</a>
</p>

<p align="center">
<a aria-label="Faust.js Core Downloads Per Month" href="https://www.npmjs.com/package/@faustjs/core">
<img alt="" src="https://img.shields.io/npm/dm/@faustjs/core?color=7e5cef&style=for-the-badge&label=@faustjs/core">
</a>
<a aria-label="Faust.js Core Downloads Per Week" href="https://www.npmjs.com/package/@faustjs/core">
<img alt="" src="https://img.shields.io/npm/dw/@faustjs/core?color=7e5cef&style=for-the-badge&label=@faustjs/core">
</a>
</p>

`@faustjs/core` is the core library for the Faust.js framework. It contains the core classes and interfaces that are used by other libraries in the framework.

NOTE: This project is in the early stages of development, but it does contain useful functionality for headless WordPress sites like authentication and post previews. Be sure to install the [WordPress plugin](https://github.com/wpengine/headless-framework) that enables the functionality in this package.

[Documentation](https://github.com/wpengine/headless-framework)

[View Faust.js Documentation](https://github.com/wpengine/headless-framework)
26 changes: 23 additions & 3 deletions packages/next/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
# WordPress Headless Framework
# @faustjs/next

[![Version](https://img.shields.io/npm/v/@wpengine/headless.svg)](https://npmjs.org/package/@wpengine/headless)
<p align="center">
<a aria-label="NPM version" href="https://www.npmjs.com/package/@faustjs/next">
<img alt="" src="https://img.shields.io/npm/v/@faustjs/next?color=7e5cef&style=for-the-badge">
</a>

<a aria-label="License" href="https://github.com/wpengine/headless-framework/blob/canary/LICENSE">
<img alt="" src="https://img.shields.io/npm/l/@faustjs/next?color=7e5cef&style=for-the-badge">
</a>
</p>

<p align="center">
<a aria-label="Faust.js Next Downloads Per Month" href="https://www.npmjs.com/package/@faustjs/next">
<img alt="" src="https://img.shields.io/npm/dm/@faustjs/next?color=7e5cef&style=for-the-badge&label=@faustjs/next">
</a>
<a aria-label="Faust.js Next Downloads Per Week" href="https://www.npmjs.com/package/@faustjs/next">
<img alt="" src="https://img.shields.io/npm/dw/@faustjs/next?color=7e5cef&style=for-the-badge&label=@faustjs/next">
</a>
</p>

`@faustjs/next` is part of the Faust.js framework. It aids in building Headless WordPress websites with Next.js.

NOTE: This project is in the early stages of development, but it does contain useful functionality for headless WordPress sites like authentication and post previews. Be sure to install the [WordPress plugin](https://github.com/wpengine/headless-framework) that enables the functionality in this package.

[Documentation](https://github.com/wpengine/headless-framework)

[View Faust.js Documentation](https://github.com/wpengine/headless-framework)
25 changes: 22 additions & 3 deletions packages/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
# WordPress Headless Framework
# @faustjs/react

[![Version](https://img.shields.io/npm/v/@wpengine/headless.svg)](https://npmjs.org/package/@wpengine/headless)
<p align="center">
<a aria-label="NPM version" href="https://www.npmjs.com/package/@faustjs/react">
<img alt="" src="https://img.shields.io/npm/v/@faustjs/react?color=7e5cef&style=for-the-badge">
</a>

<a aria-label="License" href="https://github.com/wpengine/headless-framework/blob/canary/LICENSE">
<img alt="" src="https://img.shields.io/npm/l/@faustjs/react?color=7e5cef&style=for-the-badge">
</a>
</p>

<p align="center">
<a aria-label="Faust.js React Downloads Per Month" href="https://www.npmjs.com/package/@faustjs/react">
<img alt="" src="https://img.shields.io/npm/dm/@faustjs/react?color=7e5cef&style=for-the-badge&label=@faustjs/react">
</a>
<a aria-label="Faust.js React Downloads Per Week" href="https://www.npmjs.com/package/@faustjs/react">
<img alt="" src="https://img.shields.io/npm/dw/@faustjs/react?color=7e5cef&style=for-the-badge&label=@faustjs/react">
</a>
</p>

`@faustjs/react` is part of the Faust.js framework. It aids in building Headless WordPress websites with React.js.

NOTE: This project is in the early stages of development, but it does contain useful functionality for headless WordPress sites like authentication and post previews. Be sure to install the [WordPress plugin](https://github.com/wpengine/headless-framework) that enables the functionality in this package.

[Documentation](https://github.com/wpengine/headless-framework)
[View Faust.js Documentation](https://github.com/wpengine/headless-framework)