MasonProtter commented 5 years ago

Personally, when I visit a package repo I want to see at least some simple code examples right away. Currently, one has to first navigate to the docs, and then from the main docs page to the 'Index notation with @tensor macro' before they ever see an example of what using TensorOperations.jl might look like in their code.

This PR adds adds the demo from the docs to the REAME so that potential users can see what an awesome package this is right from the start.

If it was a conscious choice to have a spartan README, thats fine and feel free to close this PR, but I think a lot of people prefer to at least see a quick code example before going to the docs.

coveralls commented 5 years ago

Coverage increased (+0.06%) to 76.834% when pulling 69ae8d5bb65aa866ba101bee2b0b12cbff996f49 on MasonProtter:patch-1 into 5283953460f70cb8a8b6746b20ed534a274ca27e on Jutho:master.

codecov[bot] commented 5 years ago

Codecov Report

Merging #64 into master will decrease coverage by 0.05%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #64      +/-   ##
==========================================
- Coverage   79.78%   79.72%   -0.06%     
==========================================
  Files          13       13              
  Lines        1390     1391       +1     
==========================================
  Hits         1109     1109              
- Misses        281      282       +1

Impacted Files	Coverage Δ
src/implementation/lrucache.jl	`79.06% <0%> (-0.62%)`	:arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 5283953...69ae8d5. Read the comment docs.

Jutho commented 5 years ago

Thanks; this is indeed very useful.

Jutho / TensorOperations.jl

Add code example to README #64

Codecov Report