From 96b27a402b5fc715f43f356598de72aaeb6081ae Mon Sep 17 00:00:00 2001 From: Tobe O Date: Thu, 18 Apr 2019 12:18:39 -0400 Subject: [PATCH] Clean up README --- README.md | 55 +++++++++++++++++++++++-------------------------------- 1 file changed, 23 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index b9f1cd7..82ae3b4 100644 --- a/README.md +++ b/README.md @@ -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) [![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) ![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) - -[API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest) - -[Roadmap](https://github.com/angel-dart/roadmap/blob/master/ROADMAP.md) - -[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/) +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) +* [PostgreSQL ORM](https://github.com/angel-dart/orm) +* [Dependency Injection](https://docs.angel-dart.dev/guides/dependency-injection) +* And [much more](https://github.com/angel-dart)... ## 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: @@ -51,17 +41,18 @@ You can even have your server run and be *hot-reloaded* on file changes: 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 -With features like the following, Angel is the all-in-one framework you should choose to build your next project: -* [Advanced, Modular Routing](https://github.com/angel-dart/route) -* [Middleware](https://angel-dart.gitbook.io/angel/the-basics/middleware) -* [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)... +## Examples and Documentation +Visit the [documentation](https://docs.angel-dart.dev/v/2.x) +for dozens of guides and resources, including video tutorials, +to get up and running as quickly as possible with Angel. -## Basic Example -Examples and complete projects can be found here: +Examples and complete projects can be found +[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