Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Hendy committed Jun 15, 2018
2 parents a5729e7 + af69cc2 commit 1f35357
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Umbraco Embedded Resource
For use by Umbraco package developers to serve embedded assets.
For use by Umbraco package developers to serve embedded resources.

Using embedded resources within an assembly for a package has a number of advantages:

1) No need to split a package into two NuGet packages; often a class library project will also need to make a reference to the package - so if the resource files are not embedded, then they are added unnecessarily into the class library.
1) No need to split a package into two NuGet packages; often a class library project will also need to make a reference, so without the resource files being embedded, they would be added unnecessarily into the class library project.

2) Without resource files on the file system, there's nothing to add (other than the NuGet reference) into source control for the end consumer.
2) With embedded resources, there's nothing to add (other than a NuGet reference) into source control for the end consumer.

3) Resources can be protected such that they are only served to back office authenticated users (so no [leakage as to what packages are installed](https://twitter.com/jschoemaker1984/status/1004231493240213505)).

Expand All @@ -21,6 +21,7 @@ Both attributes have the same two required parameters:
* The full namespace path to the embedded resource
* The app relative url that the resource should be served on


## Example

@using Our.Umbraco.EmbeddedResource
Expand Down

0 comments on commit 1f35357

Please sign in to comment.