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.

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

Prepare public beta #64

Merged
merged 1 commit into from
Nov 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,7 @@ $app->run();
```

Next, we need to install X and its dependencies to actually run this project.
Start by creating a new `composer.json` in the project directory with the following contents:

```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/clue-access/framework-x"
}
]
}
```

Finally, simply install Framework X:
In your project directory, simply run the following command:

```bash
$ composer require clue/framework-x:dev-main
Expand Down Expand Up @@ -84,7 +71,7 @@ Hello wörld!
## Documentation

Hooked?
See [website](https://framework-x.clue.engineering/) for full documentation.
See [website](https://framework-x.org/) for full documentation.

Found a typo or want to contribute?
The website documentation is build from the source documentation files in
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "clue/framework-x",
"description": "Framework X – the simple and fast micro framework for building reactive web applications that run anywhere.",
"keywords": ["microframework", "micro", "framework", "web", "http", "event-driven", "async", "ReactPHP"],
"homepage": "https://framework-x.clue.engineering/",
"homepage": "https://framework-x.org/",
"license": "MIT",
"authors": [
{
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This folder contains the source documentation files for Framework X.

You can see the [website](https://framework-x.clue.engineering/) for the
You can see the [website](https://framework-x.org/) for the
user-accessible version.

## Contribute
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Hello wörld!

You may be wondering how fast a pure PHP web server implementation could possibly be.
In fact, in benchmarks this setup outperforms any traditional PHP stack by orders of magnitude.
The answer: [Lightning fast!](https://framework-x.clue.engineering/#lightning-fast)
The answer: [Lightning fast!](https://framework-x.org/#lightning-fast)

### Listen address

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ tweet mentioning [**@x_framework**](https://twitter.com/x_framework). ❤️

## Open source

Framework X will be released as open-source under the permissive MIT license.
This means it will be free as in free speech and as in free beer.
Framework X is released as open-source under the permissive MIT license.
This means it is free as in free speech and as in free beer.

We believe in open source and made a conscious decision to take this path.
Being open-source means we can foster a community to focus on building the best possible framework together.
Expand Down
19 changes: 0 additions & 19 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,25 +51,6 @@ but the above should be just fine for starters.
## Installation

Next, we need to install X and its dependencies to actually run this project.

> ⚠️ **Beta**
>
> This project is currently in closed beta, so the installation requires a manual step first.
> This will not be necessary once the project is released to the public.
>
> Start by creating a new `composer.json` in the project directory with the following contents:
>
> ```json title="composer.json"
> {
> "repositories": [
> {
> "type": "vcs",
> "url": "https://github.com/clue-access/framework-x"
> }
> ]
> }
> ```

Thanks to [Composer](https://getcomposer.org/), this installation only requires a single command.

> ℹ️ **New to Composer?**
Expand Down
5 changes: 2 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
site_name: Framework X documentation
site_url: https://framework-x.clue.engineering/docs/
site_url: https://framework-x.org/docs/
site_dir: build/docs
extra:
homepage: ../

repo_url: https://github.com/clue/framework-x
repo_name: clue/framework-x
edit_uri: "" # not publicly accessible while in early access
edit_uri: "edit/main/docs/"

theme:
name: material
Expand All @@ -24,7 +24,6 @@ markdown_extensions:

nav:
- Getting Started:
# - "Why?": ""
- getting-started/quickstart.md
- getting-started/philosophy.md
- getting-started/community.md
Expand Down