Skip to content

Commit

Permalink
docs(readme): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
artyorsh authored Jun 11, 2019
1 parent c53fa8c commit 910fb0c
Showing 1 changed file with 81 additions and 32 deletions.
113 changes: 81 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,91 @@
<img src="https://cdn.rawgit.com/akveo/react-native-ui-kitten/085afb52/docs/assets/banner.png"/>

# react-native-ui-kitten [![Build Status][badge-travis]][link-travis] [![Coverage Status][badge-coveralls]][link-coveralls] [![Dependency Status][badge-david]][link-david] [![npm][badge-downloads]][link-downloads] [![npm][badge-license]]()
# UI Kitten [<img src="https://i.imgur.com/oMcxwZ0.png" alt="Eva Design System" height="20px" />][link:eva] [![npm][badge:license]]() [![Build Status][badge:travis]][link:travis] [![Coverage Status][badge:coveralls]][link:coveralls]

This branch contains sources of something really awesome.
We do what we did before but in a new way.
[Documentation][link:doc-homepage]

## What's new will you have:
- TypeScript support
- Full test coverage of the framework
- Better code quality
- Better development environment for contributors
- Better theme system
UI Kitten is a React Native UI Library that allows you creating stunning multi-brand cross-platform mobile applications.
The library is based on Eva Design System which brings consistency and scalability in the design and development process.
It contains a set of general purpose UI components styled in a similar way.
And the most awesome thing: the themes can be changed in the runtime, with no need to reload the application.

## How can I support the developers?
- Star our GitHub repo
- Create pull requests, submit bugs, suggest new features or documentation updates
- Follow us on [Twitter](https://twitter.com/akveo_inc)
- Like our page on [Facebook](https://www.facebook.com/akveo/)
100% Free and Open Source!

[<img src="https://i.imgur.com/pYl0trU.jpg">][link:doc-homepage]

## What's included

- **20+ general-purpose components** designed and tested to save your time.

- **Comprehensive clear documentation** with the tons of examples.

- **Theming System.** Use Light and modern Dark themes and create your own.

- **Eva Design System Support.** Construct an interface using basic components following Eva specifications and it will always have a stunning design.

## Starter App

**Kitten Tricks**[react-native starter kit][link:kitten-tricks] allows you to boost the development of a mobile app.
There is a huge variety of customizable layouts, use “as is” or add new blocks.

## Can I hire you guys?
Yes! We are available for hire. Visit [our homepage](http://akveo.com/) or simply leave us a message at contact@akveo.com. We will be happy to work with you!
**Over 40 screens in dark and light themes** give you the possibility to create a bright and exclusive app while saving your time on compiling numerous details. Also, you can download the source code and use it for your own benefit.

## Quick Start

Install UI Kitten and Eva Design System packages via npm:

```bash
npm i react-native-ui-kitten @eva-design/eva
```

Modify your application root:

```jsx
import React from 'react';
import { mapping, theme } from '@eva-design/eva';
import { ApplicationProvider } from 'react-native-ui-kitten';
import { Application } from './path-to/application.component';

export default App = () => (
<ApplicationProvider
mapping={mapping}
theme={theme}
<Application/>
</ApplicationProvider>
);
```

The code above will configure your application component to apply Eva Design System styling magic.
Read the [Theme System guide][link:doc-theme-system] for more details.

## How can I support the developers?
- Star our GitHub repo :star:
- Create pull requests, submit bugs, suggest new features or documentation updates :wrench:
- Read us on [Medium][link:akveo-medium]
- Follow us on [Twitter][link:akveo-twitter]
- Like our page on [Facebook][link:akveo-facebook]

License
-------------
<a href=/LICENSE.txt target="_blank">MIT</a> license.
## License
[MIT](LICENSE.txt) license.

### From akveo
## More from Akveo
- [Eva Icons][link:eva-icons] - 480+ beautiful Open Source icons

Enjoy!
We're always happy to receive your feedback.
## From Developers
Made with :heart: by [Akveo team][link:akveo-homepage]. Follow us on [Twitter][link:akveo-twitter] to get the latest news first!
We're always happy to receive your feedback!

[badge-travis]: https://travis-ci.com/akveo/react-native-ui-kitten.svg?branch=next
[badge-coveralls]: https://coveralls.io/repos/github/akveo/react-native-ui-kitten/badge.svg?branch=next
[badge-david]: https://david-dm.org/akveo/react-native-ui-kitten/status.svg
[badge-downloads]: https://img.shields.io/npm/dt/react-native-ui-kitten.svg
[badge-license]: https://img.shields.io/npm/l/react-native-ui-kitten.svg
[badge:license]: https://img.shields.io/npm/l/react-native-ui-kitten.svg
[badge:travis]: https://travis-ci.com/akveo/react-native-ui-kitten.svg?branch=master
[badge:coveralls]: https://coveralls.io/repos/github/akveo/react-native-ui-kitten/badge.svg?branch=master

[link-travis]: https://travis-ci.com/akveo/react-native-ui-kitten
[link-coveralls]: https://coveralls.io/github/akveo/react-native-ui-kitten?branch=next
[link-david]: https://david-dm.org/akveo/react-native-ui-kitten
[link-downloads]: https://www.npmjs.com/package/react-native-ui-kitten
[link:eva]: https://eva.design
[link:travis]: https://travis-ci.com/akveo/react-native-ui-kitten
[link:coveralls]: https://coveralls.io/github/akveo/react-native-ui-kitten?branch=master
[link:doc-homepage]: https://akveo.github.io/react-native-ui-kitten
[link:doc-theme-system]: https://akveo.github.io/react-native-ui-kitten/docs/guides/theme-system
[link:kitten-tricks]: https://github.com/akveo/kittenTricks
[link:eva-icons]: https://github.com/akveo/eva-icons
[link:akveo-homepage]: https://akveo.com
[link:akveo-medium]: https://medium.com/akveo-engineering
[link:akveo-twitter]: https://twitter.com/akveo_inc
[link:akveo-facebook]: https://www.facebook.com/akveo

0 comments on commit 910fb0c

Please sign in to comment.