#2: update readme

pull/32/head
Simon Gockner 7 years ago
parent 4fca7848bc
commit b7d0932124
  1. 51
      README.md

@ -5,15 +5,56 @@ A lightweight IOC Container that is powerful enough to do all the things you nee
## Get started with the Lightweight IOC Container
- How to install <!--Add links to wiki-->
- Example usage:
### How to install <!--TODO: Add links to wiki-->
1. Instantiating Container:
The easiest way to install the Lightweight IOC Container is by using [NuGet](https://www.nuget.org/packages/LightweightIocContainer/).
You can either use the `PackageManager` in VisualStudio:
```PM
PM> Install-Package LightweightIocContainer -Version 1.0.0
```
or you can use the `.NET CLI`:
```.net
> dotnet add package LightweightIocContainer --version 1.0.0
```
### Example usage
1. Instantiate container:
```c#
IocContainer container = new IocContainer();
```
2. more...
2. Install `IIocInstaller`s for the container:
```c#
container.Install(new Installer());
```
3. Resolve one instance from the container:
```c#
IFooFactory fooFactory = container.Resolve<IFooFactory>();
```
4. Use this instance to create what your application needs:
```c#
IFoo foo = fooFactory.Create();
```
5. When your application is finished, don't forget to dispose your `IocContainer`:
```c#
container.Dispose();
```
### Demo Project
There is a [demo project][demoProjectLink] available where you can check out how different functions of the Lightweight IOC Container can be used.
This demo project is updated with new versions of the Lightweight IOC Container to show the usage of newly implemented functions.
- demo project
[demoProjectLink]: https://github.com/SimonG96/LightweightIocContainer_Example

Loading…
Cancel
Save