Skip to content

Commit

Permalink
Update and rename README.markdown to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
scott-xu committed Sep 12, 2014
1 parent 7211206 commit f884f99
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 49 deletions.
49 changes: 0 additions & 49 deletions README.markdown

This file was deleted.

63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Meet Ninject [![NuGet Version](http://img.shields.io/nuget/v/Ninject.svg?style=flat)](https://www.nuget.org/packages/Ninject/) [![NuGet Downloads](http://img.shields.io/nuget/dt/Ninject.svg?style=flat)](https://www.nuget.org/packages/Ninject/)
Ninject is a lightning-fast, ultra-lightweight dependency injector for .NET applications. It helps you split your
application into a collection of loosely-coupled, highly-cohesive pieces, and then glue them back together in a
flexible manner. By using Ninject to support your software's architecture, your code will become easier to write,
reuse, test, and modify.

## Ninject is:

1. **Focused.** Too many existing dependency injection projects sacrifice usability for features that aren't often necessary.
Each time a feature is added to Ninject, its benefit is weighed against the complexity it adds to everyday use. Our goal
is to keep the barrier to entry - the baseline level of knowledge required to use Ninject - as low as possible. Ninject
has many advanced features, but understanding them is not required to use the basic features.

2. **Sleek.** Framework bloat is a major concern for some projects, and as such, all of Ninject's core functionality is in a
single assembly with no dependencies outside the .NET base class library. This single assembly's footprint is approximately
85KB when compiled for release.

3. **Fast.** Instead of relying on reflection for invocation, Ninject takes advantage of lightweight code generation in the CLR.
This can result in a dramatic (8-50x) improvement in performance in many situations.

4. **Precise.** Ninject helps developers get things right the first time around. Rather than relying on XML mapping files and
string identifiers to wire up components, Ninject provides a robust domain-specific language. This means that Ninject
takes advantage of the capabilities of the language (like type-safety) and the IDE (like IntelliSense and code completion).

5. **Agile.** Ninject is designed around a component-based architecture, with customization and evolution in mind. Many facets
of the system can be augmented or modified to fit the requirements of each project.

6. **Stealthy.** Ninject will not invade your code. You can easily isolate the dependency on Ninject to a single assembly in
your project.

7. **Powerful.** Ninject includes many advanced features. For example, Ninject is the first dependency injector to support
contextual binding, in which a different concrete implementation of a service may be injected depending on the context in
which it is requested.

## Everything else is in Extensions

Yes, sounds slim and focused, but where is the support for all the features that the competitors have?

Generally, they are maintained as specific focused extensions with owners who keep them in sync and pull in new ideas and fixes fast. These are summarized on the [extensions](http://ninject.org/extensions) section of the project website. Most are hosted alongside the core project right here.

## License
Ninject is intended to be used in both open-source and commercial environments. To allow its use in as many
situations as possible, Ninject is dual-licensed. You may choose to use Ninject under either the Apache License,
Version 2.0, or the Microsoft Public License (Ms-PL). These licenses are essentially identical, but you are
encouraged to evaluate both to determine which best fits your intended use.

Refer to [LICENSE.txt](https://github.com/ninject/ninject/blob/master/LICENSE.txt) for detailed information.

## CI build status
[![Build Status](https://teamcity.bbv.ch/app/rest/builds/buildType:(id:bt7)/statusIcon)](http://teamcity.bbv.ch/viewType.html?buildTypeId=bt7&guest=1)

## Changes history
- [Changes in Ninject 3](https://github.com/ninject/ninject/wiki/Changes-in-Ninject-3)
- [Changes in Ninject 2](https://github.com/ninject/ninject/wiki/Changes-in-Ninject-2)
- [Detailed release notes](https://github.com/ninject/ninject/blob/master/ReleaseNotes.md)

## Resources
- [Project website](http://ninject.org/)
- [Documentation](http://ninject.org/learn)
- [Wiki](https://github.com/ninject/ninject/wiki)
- [Nate's blog](http://kohari.org/)
- [Ian's blog](http://innovatian.com/)
- [Remo's blog](http://www.planetgeek.ch/author/remo-gloor/)

0 comments on commit f884f99

Please sign in to comment.