mrpastewart/protevus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up README

Browse source
This commit is contained in:
Tobe O 2019-04-18 12:18:39 -04:00
parent f90bcfe27b
commit 96b27a402b
1 changed files with 23 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -1,35 +1,25 @@
[![The Angel Framework](https://angel-dart.github.io/assets/images/logo.png)](https://angel-dart.github.io) [![The Angel Framework](https://angel-dart.github.io/assets/images/logo.png)](https://angel-dart.dev)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion)
[![Pub](https://img.shields.io/pub/v/angel_framework.svg)](https://pub.dartlang.org/packages/angel_framework) [![Pub](https://img.shields.io/pub/v/angel_framework.svg)](https://pub.dartlang.org/packages/angel_framework)
[![Build status](https://travis-ci.org/angel-dart/framework.svg?branch=master)](https://travis-ci.org/angel-dart/framework) [![Build status](https://travis-ci.org/angel-dart/framework.svg?branch=master)](https://travis-ci.org/angel-dart/framework)
![License](https://img.shields.io/github/license/angel-dart/framework.svg) ![License](https://img.shields.io/github/license/angel-dart/framework.svg)
**A batteries-included, full-stack Web server framework for Dart.** **A polished, production-ready backend framework in Dart.**
----- -----
## About
Angel is a full-stack Web framework in Dart. It aims to
streamline development by providing many common features
out-of-the-box in a consistent manner.
[Wiki (in-depth documentation)](https://github.com/angel-dart/angel/wiki) With features like the following, Angel is the all-in-one framework you should choose to build your next project:
* [GraphQL Support](https://github.com/angel-dart/graphql)
[API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest) * [PostgreSQL ORM](https://github.com/angel-dart/orm)
* [Dependency Injection](https://docs.angel-dart.dev/guides/dependency-injection)
[Roadmap](https://github.com/angel-dart/roadmap/blob/master/ROADMAP.md) * And [much more](https://github.com/angel-dart)...
[File an Issue](https://github.com/angel-dart/roadmap/issues)
[Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel)
Like what you see? Please lend us a star! :star:
## Newest Tutorials
* [Dependency Injection Patterns with Angel 2](https://thosakwe.com/dependency-injection-patterns-in-angel-2/)
* [Angel 2.0.0 is Almost Here - What it Means for You](https://thosakwe.com/new-features-coming-to-angel-in-version-2-0-0/)
* [GraphQL is coming to Angel (and Dart)](https://thosakwe.com/graphql-is-coming-to-angel-and-dart/)
## Installation & Setup ## Installation & Setup
*Having errors with a fresh Angel installation? See [here](https://angel-dart.gitbook.io/angel/the-basics/installation) for help.*
Once you have [Dart](https://www.dartlang.org/) installed, bootstrapping a project is as simple as running a few shell commands: Once you have [Dart](https://www.dartlang.org/) installed, bootstrapping a project is as simple as running a few shell commands:
@ -51,17 +41,18 @@ You can even have your server run and be *hot-reloaded* on file changes:
dart --observe bin/dev.dart dart --observe bin/dev.dart
``` ```
Next, check out the [detailed documentation](https://angel-dart.gitbook.io/angel) to learn to flesh out your project. Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project.
## Features ## Examples and Documentation
With features like the following, Angel is the all-in-one framework you should choose to build your next project: Visit the [documentation](https://docs.angel-dart.dev/v/2.x)
* [Advanced, Modular Routing](https://github.com/angel-dart/route) for dozens of guides and resources, including video tutorials,
* [Middleware](https://angel-dart.gitbook.io/angel/the-basics/middleware) to get up and running as quickly as possible with Angel.
* [Dependency Injection](https://angel-dart.gitbook.io/angel/the-basics/dependency-injection)
* [Strongly-typed ORM](https://github.com/angel-dart/orm)
* And [much more](https://github.com/angel-dart)...
## Basic Example Examples and complete projects can be found
Examples and complete projects can be found here: [here](https://github.com/angel-dart/examples-v2).
You can also view the [API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest).
There is also an [Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel) list.
https://github.com/angel-dart/examples-v2