Skip to content

Commit

Permalink
docs: project
Browse files Browse the repository at this point in the history
  • Loading branch information
@romelperez
romelperez committed May 2, 2019
1 parent f4ce090 commit 81be12e
Showing 1 changed file with 52 additions and 84 deletions.
136 changes: 52 additions & 84 deletions README.md
View file
Expand Up @@ -7,30 +7,39 @@
</p>

<div align="center">
<a href="https://npmjs.org/package/arwes">
<img src="https://img.shields.io/npm/v/arwes.svg" alt="version" />
</a>
<a href="https://travis-ci.org/arwesjs/arwes">
<img src="https://img.shields.io/travis/arwesjs/arwes.svg" alt="travis" />
</a>
<a href="https://npmjs.org/package/arwes">
<img src="https://img.shields.io/npm/dm/arwes.svg" alt="downloads" />
</a>
<a href="https://github.com/arwesjs/arwes">
<img src="https://img.shields.io/github/stars/arwesjs/arwes.svg?style=social&label=stars" alt="github stars" />
</a>
<a href="https://discord.gg/s5sbTkw">
<img src="https://img.shields.io/badge/chat-discord-blue.svg" alt="chat on discord">
</a>
<a href="https://github.com/arwesjs/arwes/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/arwesjs/arwes.svg?maxAge=2592000" alt="license" />
</a>
<a href="https://github.com/prettier/prettier">
<img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square" alt="code style: prettier">
</a>
<a href="https://lernajs.io">
<img src="https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg" alt="lerna" />
</a>
<a href="https://npmjs.org/package/@arwes/arwes">
<img src="https://img.shields.io/npm/v/@arwes/arwes.svg" alt="version" />
</a>
<a href="https://travis-ci.org/arwes/arwes">
<img src="https://img.shields.io/travis/arwes/arwes.svg" alt="travis" />
</a>
<a href="https://standardjs.com" alt="npm bundle size (version)">
<img src="https://img.shields.io/badge/code_style-standardjs-d2bb09.svg?style=flat-square" alt="code style: standardjs">
</a>
<a href="https://jestjs.io">
<img src="https://img.shields.io/badge/tested%20with-jest-15c213.svg?style=flat-square" alt="tested with: jest">
</a>
<a href="https://lernajs.io">
<img src="https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg" alt="lerna" />
</a>
<a href="https://github.com/arwes/arwes/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/arwes/arwes.svg?maxAge=2592000" alt="license" />
</a>
</div>

<div align="center">
<a href="https://npmjs.org/package/@arwes/arwes">
<img src="https://img.shields.io/npm/dm/@arwes/arwes.svg" alt="downloads" />
</a>
<a href="https://github.com/arwes/arwes">
<img src="https://img.shields.io/github/stars/arwes/arwes.svg?style=social&label=stars" alt="github stars" />
</a>
<a href="https://twitter.com/arwesjs">
<img src="https://img.shields.io/twitter/follow/arwesjs.svg?label=%40arwesjs&style=social" alt="Twitter Follow">
</a>
<a href="https://discord.gg/s5sbTkw">
<img src="https://img.shields.io/badge/chat-discord-blue.svg" alt="chat on discord">
</a>
</div>

_______________
Expand All @@ -45,92 +54,51 @@ 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

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

<!-- Contributors START
Romel_Perez romelperez https://romelperez.com code doc tutorial answers
Nick_West njwest https://nickwe.st doc
Contributors END -->
<!-- Contributors table START -->
| [<img src="https://avatars.githubusercontent.com/romelperez?s=100" width="100" alt="Romel Perez" /><br /><sub>Romel Perez</sub>](https://romelperez.com)<br />[💻](git@github.com:arwesjs/arwes/commits?author=romelperez) [📖](git@github.com:arwesjs/arwes/commits?author=romelperez) ✅ 💁 | [<img src="https://avatars.githubusercontent.com/njwest?s=100" width="100" alt="Nick West" /><br /><sub>Nick West</sub>](https://nickwe.st)<br />[📖](git@github.com:arwesjs/arwes/commits?author=njwest) |
| :---: | :---: |
<!-- Contributors table END -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table><tr><td align="center"><a href="https://RomelPerez.com"><img src="https://avatars2.githubusercontent.com/u/1393135?v=4" width="100px;" alt="Romel Pérez"/><br /><sub><b>Romel Pérez</b></sub></a><br /><a href="#projectManagement-romelperez" title="Project Management">📆</a> <a href="https://github.com/arwes/arwes/commits?author=romelperez" title="Code">💻</a> <a href="https://github.com/arwes/arwes/commits?author=romelperez" title="Documentation">📖</a> <a href="#question-romelperez" title="Answering Questions">💬</a></td><td align="center"><a href="https://nickwe.st"><img src="https://avatars1.githubusercontent.com/u/3742496?v=4" width="100px;" alt="Nick West 眨眼龙"/><br /><sub><b>Nick West 眨眼龙</b></sub></a><br /><a href="https://github.com/arwes/arwes/commits?author=njwest" title="Documentation">📖</a> <a href="#ideas-njwest" title="Ideas, Planning, & Feedback">🤔</a></td></tr></table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors)
specification.

0 comments on commit 81be12e

Please sign in to comment.