From 81be12eedb6de52b9adf75cadcd301bfed7528f6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Romel=20P=C3=A9rez?=
Date: Wed, 1 May 2019 19:24:54 -0500
Subject: [PATCH] docs: project
---
README.md | 136 +++++++++++++++++++++---------------------------------
1 file changed, 52 insertions(+), 84 deletions(-)
diff --git a/README.md b/README.md
index a149a0e2..8841c7de 100644
--- a/README.md
+++ b/README.md
@@ -7,30 +7,39 @@
+
+
_______________
@@ -45,21 +54,15 @@ The project has a working version with the package [`arwes`](https://npmjs.org/p
and the documentation with the website [arwes.dev](https://arwes.dev).
This is an _alpha_ release. Modules and components are being tested and their
API may change. Check out the source code at
-**[`version1-breakpoint1`](https://github.com/arwesjs/arwes/tree/version1-breakpoint1)**
+**[`version1-breakpoint1`](https://github.com/arwes/arwes/tree/version1-breakpoint1)**
branch where you can find the components and the website.
-Currently, the development is at [`master`](https://github.com/arwesjs/arwes) branch
+Currently, the development is at [`master`](https://github.com/arwes/arwes) branch
with the package [`@arwes/arwes`](https://npmjs.org/package/@arwes/arwes). It is
not a working version yet. It has major breaking changes and it is going through
-many refactors. The website will be worked once the core new version is released
-in the repository [arwes.dev repository](https://github.com/arwesjs/arwes.dev).
-See Roadmap.
-
-## Install
-
-```bash
-$ npm install --save arwes
-```
+many refactors. The website will be worked on once the core new version is released
+in the repository [arwes.dev repository](https://github.com/arwes/arwes.dev).
+See [Roadmap](./ROADMAP.md) for more details.
## Documentation
@@ -67,70 +70,35 @@ See **[arwes.dev](https://arwes.dev)**.
## Need help?
-Open [a GitHub issue](https://github.com/arwesjs/arwes/issues/new) or let's chat on [Discord](https://discord.gg/s5sbTkw).
+Open [a GitHub issue](https://github.com/arwes/arwes/issues/new) or let's chat on [Discord](https://discord.gg/s5sbTkw).
-## Inspirations
-
-This project has many sources of inspiration. Some of the main influences are:
-
-- [Star Citizen](http://robertsspaceindustries.com)
-- [Orbit SciFi UI Kit](https://creativemarket.com/dannehr/163951-Orbit-SciFi-UI-Kit)
-- [Futuristic HUD UI Pack](https://videohive.net/item/hud-ui-pack-700/19326628)
-- [Hi-Tech Interface Builder Pack](https://www.behance.net/gallery/19051971/Hi-Tech-Interface-Builder-Pack)
-- [SciFi HUD Pack](https://videohive.net/item/hud/14206389)
-- [TRON: Legacy](http://www.imdb.com/title/tt1104001)
-- [Boom Sci-Fi Designed](https://soundcloud.com/boom-library/sci-fi-designed)
+Also, read the [project code of conduct](./CODE_OF_CONDUCT.md).
## Guidelines
Check out [Arwes Guidelines](./guidelines) for detailed information about
-the concepts behind the framework.
+the concepts and inspiration projects behind the framework.
## Roadmap
-For 2018 the project was released in alpha versions where the main ideas have
-been tested out in real-world projects. Though many features are limited, have
-little support or extensibility. The plan was to gather enough insight to decide
-and build the foundation of the framework.
-
-For 2019 the plan is to work on the project by more granular sections. An ideal
-_beta release_ would be by the end of the year.
-
-- [x] Project definition
-- [ ] **Research and playground with [soulextract.com](https://github.com/soulextract/soulextract.com)**
-- Guidelines
- - [ ] Design guildelines
- - [ ] Animation and Sound guildelines
- - [ ] User Experience guildelines
-- Tools
- - [ ] Design tools
- - [ ] Animation tools
- - [ ] Sounds tools
- - [ ] Resources tools
- - [ ] Platform tools
-- Components
- - [ ] Content components
- - [ ] Shape components
- - [ ] Control components
- - [ ] Navigation components
-
-The website will be worked on the [arwes.dev repository](https://github.com/arwesjs/arwes.dev).
+Check out [Arwes Roadmap](./ROADMAP.md) for the project planning.
+
+See [changelog](./CHANGELOG.md).
## Want to contribute?
-See [how to contribute](https://github.com/arwesjs/arwes/blob/master/CONTRIBUTING.md).
+See [how to contribute](https://github.com/arwes/arwes/blob/master/CONTRIBUTING.md).
All contributions of any kind are welcome!
+Review the [project boards](https://github.com/arwes/arwes/projects).
+
## Contributors
-
-
-| [
Romel Perez](https://romelperez.com)
[π»](git@github.com:arwesjs/arwes/commits?author=romelperez) [π](git@github.com:arwesjs/arwes/commits?author=romelperez) β
π | [
Nick West](https://nickwe.st)
[π](git@github.com:arwesjs/arwes/commits?author=njwest) |
-| :---: | :---: |
-
+
+
+
+
+
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors)
specification.