readme: Add crabby, sync with aya/README.md

Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
2 years ago · 2b98259be7
parent 67951cd2d7
commit 2b98259be7
3 changed files with 310 additions and 18 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,4 @@
-# Aya
+# [![Aya](assets/logo.svg)](https://aya-rs.dev)
 [![Crates.io][crates-badge]][crates-url]
 ![License][license-badge]
@ -11,14 +11,14 @@
 [license-badge]: https://img.shields.io/badge/license-MIT%2FApache--2.0-blue?style=for-the-badge
 [build-badge]: https://img.shields.io/github/workflow/status/aya-rs/aya/build-aya?style=for-the-badge&logo=github
 [book-badge]: https://img.shields.io/badge/read%20the-book-9cf.svg?style=for-the-badge&logo=mdbook
-[book-url]: http://aya-rs.github.io/book/
+[book-url]: https://aya-rs.dev/book
 ## API Documentation
 [![Unreleased Documentation][git-docs-badge]][git-api-docs] [![Documentaiton][api-docs-badge]][api-docs]
 [git-docs-badge]: https://img.shields.io/badge/docs-unreleased-red.svg?style=for-the-badge&logo=docsdotrs
-[git-api-docs]: https://aya-rs.netlify.app
+[git-api-docs]: https://docs.aya-rs.dev
 [api-docs-badge]: https://img.shields.io/badge/docs-released-blue.svg?style=for-the-badge&logo=docsdotrs
 [api-docs]: https://docs.rs/aya
--- a/assets/logo.svg
+++ b/assets/logo.svg
@ -0,0 +1,279 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <svg
   width="420"
   height="96"
   viewBox="0 0 420 96"
   version="1.1"
   xml:space="preserve"
   style="clip-rule:evenodd;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421"
   id="svg47080"
   sodipodi:docname="aya_banner.svg"
   inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)"
   inkscape:export-filename="/home/dave/dev/aya-rs/aya/assets/doc/logo.png"
   inkscape:export-xdpi="96"
   inkscape:export-ydpi="96"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns="http://www.w3.org/2000/svg"
   xmlns:svg="http://www.w3.org/2000/svg"
   xmlns:serif="http://www.serif.com/"><defs
   id="defs47084" /><sodipodi:namedview
   id="namedview47082"
   pagecolor="#ffffff"
   bordercolor="#666666"
   borderopacity="1.0"
   inkscape:pageshadow="2"
   inkscape:pageopacity="0.0"
   inkscape:pagecheckerboard="0"
   showgrid="true"
   inkscape:zoom="2.8554688"
   inkscape:cx="176.67852"
   inkscape:cy="185.95896"
   inkscape:window-width="3052"
   inkscape:window-height="1678"
   inkscape:window-x="0"
   inkscape:window-y="0"
   inkscape:window-maximized="1"
   inkscape:current-layer="text2643"
   units="px"
   width="1000px"
   showguides="true"
   inkscape:guide-bbox="true"
   inkscape:snap-global="true"><inkscape:grid
     type="xygrid"
     id="grid941" /><sodipodi:guide
     position="60,50"
     orientation="0,-1"
     id="guide943" /><sodipodi:guide
     position="259.91104,256.89588"
     orientation="1,0"
     id="guide947" /></sodipodi:namedview>
    <g
   inkscape:groupmode="layer"
   id="layer8"
   inkscape:label="background"><g
     aria-label="AYA"
     transform="scale(0.98873505,1.0113933)"
     id="text2643"
     style="font-size:114.766px;line-height:1.25;stroke-width:2"><path
       d="m 155.86494,89.137665 h 19.05115 l 7.57456,-15.149112 h 41.77482 l 7.57456,15.149112 h 25.13375 L 216.80568,8.8014656 h -20.77264 z m 34.88886,-31.675416 12.62426,-25.24852 12.62426,25.24852 z"
       style="font-family:'The Neue';-inkscape-font-specification:'The Neue, Normal';stroke:#ffffff"
       id="path23954" /><path
       d="m 232.87277,8.8014656 39.70904,41.3157594 v 39.02044 h 23.41226 V 50.117225 L 338.91656,8.8014656 h -23.9861 L 287.96045,36.115773 262.59717,8.8014656 Z"
       style="font-family:'The Neue';-inkscape-font-specification:'The Neue, Normal';stroke:#ffffff"
       id="path23956" /><path
       d="m 313.78266,89.137665 h 19.05116 l 7.57455,-15.149112 h 41.77483 l 7.57455,15.149112 h 25.13376 L 374.72341,8.8014656 h -20.77265 z m 34.88887,-31.675416 12.62426,-25.24852 12.62426,25.24852 z"
       style="font-family:'The Neue';-inkscape-font-specification:'The Neue, Normal';stroke:#ffffff"
       id="path23958" /></g></g><g
   inkscape:groupmode="layer"
   id="layer7"
   inkscape:label="crabee"><g
     inkscape:groupmode="layer"
     id="layer3"
     inkscape:label="Legs"
     style="display:inline"><g
       id="Layer-1"
       serif:id="Layer 1"
       style="clip-rule:evenodd;display:inline;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421"
       transform="matrix(0.11498308,0,0,0.11498308,7.8739489,1.3142969)">
        <g
   transform="translate(597.344,637.02)"
   id="g47033"
   style="fill:#000000">
            <path
   d="m 0,-279.559 c -121.238,0 -231.39,14.576 -312.939,38.329 V -38.329 C -231.39,-14.575 -121.238,0 0,0 138.76,0 262.987,-19.092 346.431,-49.186 V -230.37 C 262.987,-260.465 138.76,-279.559 0,-279.559"
   style="fill:#000000;fill-rule:nonzero"
   id="path47031" />
        </g>
        <g
   transform="translate(1068.75,575.642)"
   id="g47037"
   style="fill:#000000">
            <path
   d="m 0,-53.32 -14.211,-29.441 c 0.073,-1.118 0.131,-2.237 0.131,-3.36 0,-33.375 -34.706,-64.135 -93.097,-88.762 V 2.643 c 27.245,-11.492 49.348,-24.317 65.156,-38.125 -4.652,18.707 -20.564,56.553 -33.25,83.168 -20.85,38.066 -28.4,71.203 -27.432,72.844 0.617,1.033 7.73,-9.94 18.219,-27.721 C -60.074,58.028 -13.82,-8.373 -4.575,-25.287 5.897,-44.461 0,-53.32 0,-53.32"
   style="fill:#000000;fill-rule:nonzero"
   id="path47035" />
        </g>
        <g
   transform="translate(149.064,591.421)"
   id="g47041"
   style="fill:#000000">
            <path
   d="m 0,-99.954 c 0,6.428 1.293,12.76 3.788,18.969 l -8.511,15.15 c 0,0 -6.818,8.846 5.188,27.508 10.59,16.455 63.635,80.867 91.632,114.598 12.026,17.293 20.179,27.945 20.893,26.916 1.124,-1.633 -7.476,-34.1 -31.359,-71.141 -11.144,-19.895 -24.454,-46.252 -32.442,-65.721 22.303,14.116 51.483,26.92 86.152,37.94 V -204.17 C 51.797,-177.622 0,-140.737 0,-99.954"
   style="fill:#000000;fill-rule:nonzero"
   id="path47039" />
        </g>
        <g
   transform="translate(450.328,483.629)"
   id="g47049">
            <path
   d="m 0,167.33 c -1.664,-1.42 -2.536,-2.262 -2.536,-2.262 L 140.006,153.391 C 23.733,0 -69.418,122.193 -79.333,135.855 v 31.475 z"
   style="fill-rule:nonzero"
   id="path47047" />
        </g>
        <g
   transform="translate(747.12,477.333)"
   id="g47053">
            <path
   d="m 0,171.974 c 1.663,-1.42 2.536,-2.264 2.536,-2.264 L -134.448,159.687 C -18.12,0 69.421,126.835 79.335,140.497 v 31.477 z"
   style="fill-rule:nonzero"
   id="path47051" />
        </g>
    </g></g><g
     inkscape:groupmode="layer"
     id="layer2"
     inkscape:label="Shell"
     style="display:inline"><g
       transform="matrix(0.11498308,0,0,0.11498308,138.19676,33.382047)"
       id="g47045"
       style="clip-rule:evenodd;display:inline;fill:#ffcc00;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="m 0,240.343 -93.415,-68.811 c -0.88,-3.064 -1.756,-6.127 -2.662,-9.162 l 30.683,-44.451 c 3.13,-4.522 3.765,-10.398 1.731,-15.555 -2.037,-5.13 -6.491,-8.81 -11.763,-9.71 l -51.884,-8.805 c -2.008,-4.102 -4.116,-8.142 -6.23,-12.15 l 21.797,-49.903 c 2.243,-5.087 1.769,-10.995 -1.203,-15.608 -2.961,-4.636 -7.99,-7.344 -13.349,-7.133 l -52.656,1.913 c -2.727,-3.55 -5.496,-7.068 -8.321,-10.521 l 12.1,-53.49 c 1.225,-5.433 -0.322,-11.118 -4.103,-15.064 -3.762,-3.932 -9.229,-5.559 -14.426,-4.283 l -51.289,12.608 c -3.321,-2.935 -6.698,-5.833 -10.114,-8.673 l 1.848,-54.914 c 0.198,-5.559 -2.393,-10.842 -6.844,-13.925 -4.446,-3.104 -10.093,-3.573 -14.956,-1.266 l -47.847,22.747 c -3.854,-2.21 -7.728,-4.4 -11.644,-6.517 l -8.455,-54.115 c -0.857,-5.483 -4.385,-10.139 -9.326,-12.266 -4.923,-2.137 -10.568,-1.447 -14.891,1.808 l -42.659,32.007 c -4.2,-1.395 -8.419,-2.732 -12.692,-4.011 l -18.386,-51.316 c -1.87,-5.229 -6.181,-9.071 -11.438,-10.151 -5.239,-1.072 -10.63,0.742 -14.263,4.802 l -35.906,40.171 c -4.343,-0.5 -8.686,-0.956 -13.043,-1.331 l -27.724,-46.713 c -2.81,-4.732 -7.77,-7.612 -13.116,-7.612 -5.334,0 -10.304,2.88 -13.09,7.612 l -27.733,46.713 c -4.358,0.375 -8.722,0.831 -13.056,1.331 l -35.91,-40.171 c -3.636,-4.06 -9.047,-5.874 -14.268,-4.802 -5.255,1.092 -9.573,4.922 -11.433,10.151 l -18.402,51.316 c -4.26,1.279 -8.481,2.627 -12.691,4.011 l -42.644,-32.007 c -4.336,-3.266 -9.98,-3.955 -14.916,-1.808 -4.919,2.127 -8.461,6.783 -9.313,12.266 l -8.461,54.115 c -3.914,2.117 -7.789,4.294 -11.653,6.517 l -47.842,-22.747 c -4.858,-2.316 -10.529,-1.838 -14.954,1.266 -4.445,3.083 -7.042,8.366 -6.84,13.925 l 1.835,54.914 c -3.405,2.84 -6.774,5.738 -10.112,8.673 l -51.279,-12.608 c -5.21,-1.265 -10.67,0.351 -14.441,4.283 -3.795,3.946 -5.331,9.631 -4.113,15.064 l 12.079,53.49 c -2.802,3.467 -5.575,6.971 -8.293,10.521 l -52.655,-1.913 c -5.314,-0.157 -10.386,2.497 -13.356,7.133 -2.973,4.613 -3.423,10.521 -1.213,15.608 l 21.816,49.903 c -2.119,4.008 -4.224,8.048 -6.249,12.15 l -51.887,8.805 c -5.27,0.888 -9.71,4.566 -11.76,9.71 -2.04,5.157 -1.37,11.033 1.73,15.555 l 30.7,44.451 c -0.24,0.784 -0.46,1.577 -0.7,2.364 l -86.77,92.17 c 0,0 -13.29,10.423 6.07,34.916 17.07,21.605 104.724,107.252 151.018,152.123 19.554,22.779 32.948,36.886 34.349,35.666 2.208,-1.94 -9.387,-43.385 -47.902,-92.012 -29.685,-43.629 -68.215,-110.733 -59.175,-118.467 0,0 10.27,-13.045 30.893,-22.435 0.753,0.603 -0.781,-0.598 0,0 0,0 435.152,200.732 838.797,3.396 46.108,-8.273 74.023,16.43 74.023,16.43 9.628,5.58 -15.301,74.578 -35.798,120.254 -27.881,51.863 -31.97,92.332 -29.604,93.736 1.491,0.889 11.634,-14.545 26.104,-39.109 C -79.843,391.654 -12.354,296.816 0,273.782 14.006,247.663 0,240.343 0,240.343"
   style="fill:#ffcc00;fill-rule:nonzero"
   id="path47043" />
        </g></g><g
     inkscape:groupmode="layer"
     id="layer5"
     inkscape:label="Markings"><ellipse
       style="fill:#000000;stroke:#000000;stroke-width:0.204102"
       id="path319"
       cx="75.04847"
       cy="52.952305"
       rx="26.31949"
       ry="15.099205" /><ellipse
       style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:4.44015;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
       id="path423"
       cx="74.828163"
       cy="52.438286"
       rx="35.20956"
       ry="18.547951" /><ellipse
       style="clip-rule:evenodd;fill:#000000;fill-opacity:0;fill-rule:evenodd;stroke:#000000;stroke-width:4.57705;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
       id="path423-3"
       cx="74.440536"
       cy="48.160007"
       rx="45.578918"
       ry="24.435045" /></g><g
     inkscape:groupmode="layer"
     id="layer6"
     inkscape:label="Wings"
     style="display:inline"><ellipse
       style="clip-rule:evenodd;fill:#c1fffa;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.574913;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
       id="path977"
       cx="54.086082"
       cy="0.03193539"
       rx="27.801167"
       ry="8.3451214"
       transform="rotate(22.166895)" /><ellipse
       style="clip-rule:evenodd;fill:#c1fffa;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.574913;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
       id="ellipse2369"
       cx="-85.793182"
       cy="57.124409"
       rx="27.801167"
       ry="8.3451204"
       transform="matrix(-0.92608874,0.37730576,0.37730576,0.92608874,0,0)" /><g
       id="g3771"
       transform="matrix(0.11498308,0,0,0.11498308,7.8739489,1.3142969)"><path
         style="clip-rule:evenodd;fill:#5fa8ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:5;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
         id="path2509-3"
         d="m 176.76083,102.59373 c 10.48622,2.15024 20.88,4.71573 31.29237,7.1917 34.76986,8.74786 69.56095,17.4098 104.39745,25.88951 40.7881,10.26698 81.43657,21.86214 119.9943,38.88561 7.33104,3.23669 14.48835,6.8534 21.73252,10.2801 23.9166,12.59397 47.69564,26.35611 67.64167,44.83632 10.82979,10.03391 12.49148,13.04437 21.44219,24.43313 2.56057,3.86379 5.12113,7.72758 7.6817,11.59137 0,0 11.38391,-6.67967 11.38391,-6.67967 v 0 c -2.64822,-3.85015 -5.29643,-7.7003 -7.94465,-11.55045 -9.05404,-11.36514 -10.86919,-14.54081 -21.80757,-24.52129 -20.23559,-18.46352 -44.37629,-32.01151 -68.47461,-44.66858 -7.26016,-3.44203 -14.42489,-7.09299 -21.78047,-10.32608 -38.60832,-16.97002 -79.32036,-28.38516 -120.01428,-39.08049 -20.22672,-5.11275 -40.39438,-10.42431 -60.58717,-15.66683 -13.42874,-3.48642 -17.26062,-4.33929 -30.29564,-7.85267 -4.03736,-1.0882 -8.05839,-2.23611 -12.08759,-3.35416 -10.1347,-2.628217 -20.21057,-5.478978 -30.40597,-7.861622 0,0 -12.16816,8.454102 -12.16816,8.454102 z" /><path
         style="clip-rule:evenodd;fill:#5fa8ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:5;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
         id="path2511-6"
         d="m 402.92414,156.84453 c -0.62264,0.10322 -1.2412,0.23512 -1.86793,0.30966 -4.12254,0.49028 -6.92714,0.58188 -11.31546,0.87912 -10.01805,0.67856 -16.42671,1.20293 -26.78634,1.65072 -5.63446,0.24354 -11.27372,0.35937 -16.91059,0.53906 -20.57197,0.48125 -41.16897,-0.46479 -61.43469,-4.16984 -8.25956,-1.51004 -12.4696,-2.69037 -20.40799,-4.68128 -7.73385,-2.15623 -15.26711,-5.01655 -22.47103,-8.56318 -4.39711,-2.16477 -6.81702,-3.69036 -10.95152,-6.13145 0,0 -11.94579,7.75255 -11.94579,7.75255 v 0 c 3.88967,2.22712 7.1309,4.16019 11.19427,6.1426 7.33338,3.57776 14.99704,6.45081 22.86534,8.60951 11.33956,2.68762 22.69088,5.16399 34.27986,6.56388 16.09227,1.94386 32.32547,2.1992 48.51308,2.04624 5.57758,-0.12559 11.15625,-0.20978 16.73274,-0.37677 8.74159,-0.26175 17.23884,-0.69853 25.95641,-1.03713 3.62279,-0.14071 7.25234,-0.13715 10.87018,-0.37312 0.60919,-0.0397 1.2106,-0.15879 1.8159,-0.23818 0,0 11.86356,-8.92239 11.86356,-8.92239 z" /><path
         style="clip-rule:evenodd;fill:#5fa8ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:5;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
         id="path2513-7"
         d="m 535.85588,225.31821 c -4.25747,0.27683 -5.95399,0.4571 -10.95639,0.25275 -7.84256,-0.32037 -18.07803,-1.4359 -25.6643,-2.3401 -15.77669,-1.88041 -17.6995,-2.32505 -33.64103,-4.79522 -12.9308,-2.44415 -20.64218,-3.71728 -33.3647,-6.83915 -5.15526,-1.265 -10.24798,-2.77243 -15.37198,-4.15865 0,0 -10.66401,7.32723 -10.66401,7.32723 v 0 c 5.16236,1.38368 10.29378,2.88849 15.4871,4.15105 12.19482,2.9647 21.11663,4.49934 33.47846,6.85395 16.62334,2.67926 16.97997,2.84483 33.34239,5.06858 6.51039,0.88481 18.05956,2.3889 25.01175,2.96755 5.33581,0.44411 6.09594,0.36283 10.42132,0.29524 0,0 11.92139,-8.78323 11.92139,-8.78323 z" /></g><path
       style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-width:0.574913;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
       id="path2509"
       d="m 28.888364,12.420921 c 1.205726,0.247177 2.400854,0.542234 3.598098,0.826939 3.997923,1.005859 7.998315,2.001841 12.003933,2.976852 4.689945,1.180525 9.363824,2.513775 13.797307,4.471188 0.842954,0.372158 1.665927,0.788024 2.498886,1.18204 2.750002,1.448083 5.484192,3.030497 7.777655,5.155423 1.245215,1.153712 1.436303,1.499884 2.465467,2.809397 0.294421,0.444271 0.588834,0.888532 0.883281,1.332794 0,0 1.308955,-0.768042 1.308955,-0.768042 v 0 c -0.304509,-0.442706 -0.609009,-0.885403 -0.913494,-1.3281 -1.041078,-1.306808 -1.249789,-1.671955 -2.507518,-2.819546 -2.326755,-2.122972 -5.102531,-3.680772 -7.87342,-5.136117 -0.834802,-0.395784 -1.658603,-0.81559 -2.504382,-1.187333 C 54.983823,17.985141 50.30263,16.67261 45.623525,15.442819 43.297786,14.85494 40.978861,14.244213 38.657029,13.641402 37.112945,13.240519 36.672346,13.142456 35.173535,12.73847 34.709292,12.613369 34.246951,12.481356 33.783664,12.3528 c -1.165314,-0.302184 -2.323871,-0.629972 -3.49617,-0.903938 0,0 -1.39913,0.972059 -1.39913,0.972059 z" /><path
       style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-width:0.574913;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
       id="path2511"
       d="m 54.433372,18.428878 c -0.07163,0.01269 -0.142754,0.02698 -0.214648,0.0356 -0.474018,0.05624 -0.796487,0.0668 -1.301083,0.101128 -1.151903,0.07797 -1.888792,0.138222 -3.07999,0.189668 -0.647857,0.02799 -1.296272,0.04135 -1.944433,0.06207 -2.365406,0.05522 -4.733722,-0.05345 -7.063926,-0.479481 -0.94972,-0.173525 -1.433809,-0.309346 -2.346575,-0.538267 -0.88926,-0.24793 -1.755467,-0.576801 -2.583792,-0.984625 -0.505602,-0.248946 -0.783855,-0.424315 -1.259243,-0.705012 0,0 -1.373576,0.891432 -1.373576,0.891432 v 0 c 0.447263,0.256082 0.819953,0.478339 1.287164,0.706271 0.843207,0.411402 1.724391,0.741736 2.629116,0.98997 1.303865,0.309024 2.609083,0.593755 3.941623,0.754724 1.850326,0.223467 3.716879,0.252885 5.578172,0.235321 0.641329,-0.01514 1.282776,-0.0252 1.923979,-0.04338 1.005156,-0.03002 1.982188,-0.08041 2.984563,-0.119307 0.416551,-0.01514 0.833897,-0.01514 1.24989,-0.04287 0.07011,-0.0051 0.139229,-0.01767 0.208838,-0.02748 0,0 1.364098,-1.025943 1.364098,-1.025943 z" /><path
       style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-width:0.574913;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
       id="path2513"
       d="m 69.718276,26.302198 c -0.489534,0.03179 -0.684606,0.05242 -1.259792,0.02901 -0.901773,-0.03687 -2.078664,-0.165213 -2.950951,-0.269078 -1.814058,-0.216153 -2.035157,-0.267353 -3.868157,-0.551374 -1.48682,-0.281036 -2.373507,-0.427417 -3.836372,-0.786383 -0.592773,-0.145528 -1.178352,-0.318783 -1.767524,-0.478187 0,0 -1.226171,0.842522 -1.226171,0.842522 v 0 c 0.593577,0.159151 1.183603,0.332127 1.780732,0.477299 1.40221,0.340888 2.428066,0.517339 3.84947,0.788075 1.911412,0.308086 1.952398,0.327112 3.833792,0.582805 0.748602,0.101647 2.076549,0.274701 2.875946,0.341233 0.613526,0.05099 0.700918,0.04161 1.198276,0.03408 0,0 1.370751,-1.009917 1.370751,-1.009917 z" /><g
       id="g3789"
       transform="matrix(-0.11498308,0,0,0.11498308,142.1269,1.3142969)"><path
         style="clip-rule:evenodd;fill:#5fa8ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:5;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
         id="path3783"
         d="m 176.76083,102.59373 c 10.48622,2.15024 20.88,4.71573 31.29237,7.1917 34.76986,8.74786 69.56095,17.4098 104.39745,25.88951 40.7881,10.26698 81.43657,21.86214 119.9943,38.88561 7.33104,3.23669 14.48835,6.8534 21.73252,10.2801 23.9166,12.59397 47.69564,26.35611 67.64167,44.83632 10.82979,10.03391 12.49148,13.04437 21.44219,24.43313 2.56057,3.86379 5.12113,7.72758 7.6817,11.59137 0,0 11.38391,-6.67967 11.38391,-6.67967 v 0 c -2.64822,-3.85015 -5.29643,-7.7003 -7.94465,-11.55045 -9.05404,-11.36514 -10.86919,-14.54081 -21.80757,-24.52129 -20.23559,-18.46352 -44.37629,-32.01151 -68.47461,-44.66858 -7.26016,-3.44203 -14.42489,-7.09299 -21.78047,-10.32608 -38.60832,-16.97002 -79.32036,-28.38516 -120.01428,-39.08049 -20.22672,-5.11275 -40.39438,-10.42431 -60.58717,-15.66683 -13.42874,-3.48642 -17.26062,-4.33929 -30.29564,-7.85267 -4.03736,-1.0882 -8.05839,-2.23611 -12.08759,-3.35416 -10.1347,-2.628217 -20.21057,-5.478978 -30.40597,-7.861622 0,0 -12.16816,8.454102 -12.16816,8.454102 z" /><path
         style="clip-rule:evenodd;fill:#5fa8ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:5;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
         id="path3785"
         d="m 402.92414,156.84453 c -0.62264,0.10322 -1.2412,0.23512 -1.86793,0.30966 -4.12254,0.49028 -6.92714,0.58188 -11.31546,0.87912 -10.01805,0.67856 -16.42671,1.20293 -26.78634,1.65072 -5.63446,0.24354 -11.27372,0.35937 -16.91059,0.53906 -20.57197,0.48125 -41.16897,-0.46479 -61.43469,-4.16984 -8.25956,-1.51004 -12.4696,-2.69037 -20.40799,-4.68128 -7.73385,-2.15623 -15.26711,-5.01655 -22.47103,-8.56318 -4.39711,-2.16477 -6.81702,-3.69036 -10.95152,-6.13145 0,0 -11.94579,7.75255 -11.94579,7.75255 v 0 c 3.88967,2.22712 7.1309,4.16019 11.19427,6.1426 7.33338,3.57776 14.99704,6.45081 22.86534,8.60951 11.33956,2.68762 22.69088,5.16399 34.27986,6.56388 16.09227,1.94386 32.32547,2.1992 48.51308,2.04624 5.57758,-0.12559 11.15625,-0.20978 16.73274,-0.37677 8.74159,-0.26175 17.23884,-0.69853 25.95641,-1.03713 3.62279,-0.14071 7.25234,-0.13715 10.87018,-0.37312 0.60919,-0.0397 1.2106,-0.15879 1.8159,-0.23818 0,0 11.86356,-8.92239 11.86356,-8.92239 z" /><path
         style="clip-rule:evenodd;fill:#5fa8ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:5;stroke-linejoin:round;stroke-miterlimit:1.41421;stroke-dasharray:none"
         id="path3787"
         d="m 535.85588,225.31821 c -4.25747,0.27683 -5.95399,0.4571 -10.95639,0.25275 -7.84256,-0.32037 -18.07803,-1.4359 -25.6643,-2.3401 -15.77669,-1.88041 -17.6995,-2.32505 -33.64103,-4.79522 -12.9308,-2.44415 -20.64218,-3.71728 -33.3647,-6.83915 -5.15526,-1.265 -10.24798,-2.77243 -15.37198,-4.15865 0,0 -10.66401,7.32723 -10.66401,7.32723 v 0 c 5.16236,1.38368 10.29378,2.88849 15.4871,4.15105 12.19482,2.9647 21.11663,4.49934 33.47846,6.85395 16.62334,2.67926 16.97997,2.84483 33.34239,5.06858 6.51039,0.88481 18.05956,2.3889 25.01175,2.96755 5.33581,0.44411 6.09594,0.36283 10.42132,0.29524 0,0 11.92139,-8.78323 11.92139,-8.78323 z" /></g><g
       id="g3797"
       transform="matrix(-0.11498308,0,0,0.11498308,142.1269,1.3142969)"
       style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-opacity:1"><path
         style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-width:5;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
         id="path3791"
         d="m 182.76083,96.593738 c 10.48622,2.150236 20.88,4.715722 31.29237,7.191692 34.76986,8.74786 69.56095,17.4098 104.39745,25.88951 40.7881,10.26698 81.43657,21.86214 119.9943,38.88561 7.33104,3.23669 14.48835,6.8534 21.73252,10.2801 23.9166,12.59397 47.69564,26.35611 67.64167,44.83632 10.82979,10.03391 12.49148,13.04437 21.44219,24.43313 2.56057,3.86379 5.12113,7.72758 7.6817,11.59137 0,0 11.38391,-6.67967 11.38391,-6.67967 v 0 c -2.64822,-3.85015 -5.29643,-7.7003 -7.94465,-11.55045 -9.05404,-11.36514 -10.86919,-14.54081 -21.80757,-24.52129 -20.23559,-18.46352 -44.37629,-32.01151 -68.47461,-44.66858 -7.26016,-3.44203 -14.42489,-7.09299 -21.78047,-10.32608 -38.60832,-16.97002 -79.32036,-28.38516 -120.01428,-39.08049 -20.22672,-5.11275 -40.39438,-10.42431 -60.58717,-15.66683 -13.42874,-3.48642 -17.26062,-4.33929 -30.29564,-7.852665 -4.03736,-1.088204 -8.05839,-2.236108 -12.08759,-3.354163 -10.1347,-2.628215 -20.21057,-5.478976 -30.40597,-7.86162 0,0 -12.16816,8.454106 -12.16816,8.454106 z" /><path
         style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-width:5;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
         id="path3793"
         d="m 404.92414,148.84453 c -0.62264,0.10322 -1.2412,0.23512 -1.86793,0.30966 -4.12254,0.49028 -6.92714,0.58188 -11.31546,0.87912 -10.01805,0.67856 -16.42671,1.20293 -26.78634,1.65072 -5.63446,0.24354 -11.27372,0.35937 -16.91059,0.53906 -20.57197,0.48125 -41.16897,-0.46479 -61.43469,-4.16984 -8.25956,-1.51004 -12.4696,-2.69037 -20.40799,-4.68128 -7.73385,-2.15623 -15.26711,-5.01655 -22.47103,-8.56318 -4.39711,-2.16477 -6.81702,-3.69036 -10.95152,-6.13145 0,0 -11.94579,7.75255 -11.94579,7.75255 v 0 c 3.88967,2.22712 7.1309,4.16019 11.19427,6.1426 7.33338,3.57776 14.99704,6.45081 22.86534,8.60951 11.33956,2.68762 22.69088,5.16399 34.27986,6.56388 16.09227,1.94386 32.32547,2.1992 48.51308,2.04624 5.57758,-0.12559 11.15625,-0.20978 16.73274,-0.37677 8.74159,-0.26175 17.23884,-0.69853 25.95641,-1.03713 3.62279,-0.14071 7.25234,-0.13715 10.87018,-0.37312 0.60919,-0.0397 1.2106,-0.15879 1.8159,-0.23818 0,0 11.86356,-8.92239 11.86356,-8.92239 z" /><path
         style="fill:#656565;fill-opacity:1;stroke:#656565;stroke-width:5;stroke-miterlimit:1.41421;stroke-dasharray:none;stroke-opacity:1"
         id="path3795"
         d="m 537.85588,217.31821 c -4.25747,0.27683 -5.95399,0.4571 -10.95639,0.25275 -7.84256,-0.32037 -18.07803,-1.4359 -25.6643,-2.3401 -15.77669,-1.88041 -17.6995,-2.32505 -33.64103,-4.79522 -12.9308,-2.44415 -20.64218,-3.71728 -33.3647,-6.83915 -5.15526,-1.265 -10.24798,-2.77243 -15.37198,-4.15865 0,0 -10.66401,7.32723 -10.66401,7.32723 v 0 c 5.16236,1.38368 10.29378,2.88849 15.4871,4.15105 12.19482,2.9647 21.11663,4.49934 33.47846,6.85395 16.62334,2.67926 16.97997,2.84483 33.34239,5.06858 6.51039,0.88481 18.05956,2.3889 25.01175,2.96755 5.33581,0.44411 6.09594,0.36283 10.42132,0.29524 0,0 11.92139,-8.78323 11.92139,-8.78323 z" /></g></g><g
     inkscape:groupmode="layer"
     id="layer4"
     inkscape:label="Claws"><g
       transform="matrix(0.11498308,0,0,0.11498308,118.95854,94.569486)"
       id="g47057"
       style="clip-rule:evenodd;display:inline;fill:#333333;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="m 0,-314.014 c 0,0 -15.576,62.041 -112.453,127.238 l -27.166,6.367 c 0,0 -87.881,-160.259 -212.383,20.334 0,0 38.802,-22.591 142.822,4.92 0,0 -47.85,73.239 -144.242,70.989 0,0 92.373,110.82 232.94,-49.252 0,0 148.595,-57.463 160.646,-180.596 z"
   style="fill:#333333;fill-rule:nonzero"
   id="path47055" />
        </g><g
       transform="matrix(0.11498308,0,0,0.11498308,58.627143,80.380683)"
       id="g47077"
       style="clip-rule:evenodd;display:inline;fill:#333333;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="M 0,-25.102 C 91.833,-36.676 144.904,-37.754 144.904,-37.754 22.037,-199.838 -77.661,-53.098 -77.661,-53.098 c -24.982,-8.932 -50.453,-43.613 -69.477,-75.59 l -76.237,-22.58 C -135.502,-2.127 -70.08,0.146 -70.08,0.146 66.134,174.736 130.663,34.441 130.663,34.441 54.195,25.759 0,-25.102 0,-25.102"
   style="fill:#333333;fill-rule:nonzero"
   id="path47075" />
        </g></g><g
     inkscape:groupmode="layer"
     id="layer1"
     inkscape:label="Eyes"
     style="display:inline"><g
       transform="matrix(0.11498308,0,0,0.11498308,85.762582,59.910817)"
       id="g47061"
       style="clip-rule:evenodd;display:inline;fill:#ffffff;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="m 0,-92.063 c 0,0 43.486,-47.615 86.974,0 0,0 34.17,63.492 0,95.234 0,0 -55.912,44.444 -86.974,0 0,0 -37.275,-34.921 0,-95.234"
   style="fill:#ffffff;fill-rule:nonzero"
   id="path47059" />
        </g><g
       transform="matrix(0.11498308,0,0,0.11498308,91.551586,51.35597)"
       id="g47065"
       style="clip-rule:evenodd;display:inline;fill:#000000;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="m 0,0.002 c 0,18.541 -10.93,33.572 -24.408,33.572 -13.477,0 -24.406,-15.031 -24.406,-33.572 0,-18.541 10.929,-33.574 24.406,-33.574 C -10.93,-33.572 0,-18.539 0,0.002"
   style="fill:#000000;fill-rule:nonzero"
   id="path47063" />
        </g><g
       transform="matrix(0.11498308,0,0,0.11498308,63.445291,59.148948)"
       id="g47069"
       style="clip-rule:evenodd;display:inline;fill:#ffffff;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="m 0,-98.439 c 0,0 74.596,-33.028 94.956,40.691 0,0 21.327,85.926 -61.259,90.776 0,0 -105.31,-20.283 -33.697,-131.467"
   style="fill:#ffffff;fill-rule:nonzero"
   id="path47067" />
        </g><g
       transform="matrix(0.11498308,0,0,0.11498308,67.753245,51.496129)"
       id="g47073"
       style="clip-rule:evenodd;display:inline;fill:#000000;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421">
            <path
   d="m 0,0 c 0,19.119 -11.27,34.627 -25.173,34.627 -13.898,0 -25.171,-15.508 -25.171,-34.627 0,-19.124 11.273,-34.627 25.171,-34.627 C -11.27,-34.627 0,-19.124 0,0"
   style="fill:#000000;fill-rule:nonzero"
   id="path47071" />
        </g></g></g>
 </svg>
--- a/aya/README.md
+++ b/aya/README.md
@ -1,21 +1,38 @@
-# Aya
+# [![Aya](../assets/logo.svg)](https://aya-rs.dev)
 [![Crates.io][crates-badge]][crates-url]
 ![License][license-badge]
 ![Build status][build-badge]
-[![Documentaiton][docs-badge]][docs-url]
+[![Book][book-badge]][book-url]
-[crates-badge]: https://img.shields.io/crates/v/aya.svg
+
 [crates-badge]: https://img.shields.io/crates/v/aya.svg?style=for-the-badge&logo=rust
 [crates-url]: https://crates.io/crates/aya
-[license-badge]: https://img.shields.io/badge/license-MIT%2FApache--2.0-blue
+[license-badge]: https://img.shields.io/badge/license-MIT%2FApache--2.0-blue?style=for-the-badge
-[build-badge]: https://github.com/aya-rs/aya/actions/workflows/build-test.yml/badge.svg
+[build-badge]: https://img.shields.io/github/workflow/status/aya-rs/aya/build-aya?style=for-the-badge&logo=github
-[docs-badge]: https://img.shields.io/badge/docs-website-blue.svg
+[book-badge]: https://img.shields.io/badge/read%20the-book-9cf.svg?style=for-the-badge&logo=mdbook
-[docs-url]: http://aya-rs.github.io/book/
+[book-url]: https://aya-rs.dev/book
 ## API Documentation
-[API docs][api-docs] | [Chat][chat-url]
+[![Unreleased Documentation][git-docs-badge]][git-api-docs] [![Documentaiton][api-docs-badge]][api-docs]
 [git-docs-badge]: https://img.shields.io/badge/docs-unreleased-red.svg?style=for-the-badge&logo=docsdotrs
 [git-api-docs]: https://docs.aya-rs.dev
 [api-docs-badge]: https://img.shields.io/badge/docs-released-blue.svg?style=for-the-badge&logo=docsdotrs
 [api-docs]: https://docs.rs/aya
 ## Community
 [![Discord][discord-badge]][chat-url] [![Awesome][awesome-badge]][awesome-aya]
 Join [the conversation on Discord][chat-url] to discuss anything related to Aya, or discover
 and contribute to a list of [Awesome Aya][awesome-aya] projects.
 [discord-badge]: https://img.shields.io/badge/Discord-chat-5865F2?style=for-the-badge&logo=discord
 [chat-url]: https://discord.gg/xHW2cb2N6G
 [awesome-aya]: https://github.com/aya-rs/awesome-aya
 [awesome-badge]: https://img.shields.io/badge/Awesome-Aya-FC60A8?style=for-the-badge&logo=awesomelists
 ## Overview
@ -46,7 +63,7 @@ Some of the major features provided include:
 [libbpf]: https://github.com/libbpf/libbpf
 [bcc]: https://github.com/iovisor/bcc
 [libc]: https://docs.rs/libc
-[co-re]: https://facebookmicrosites.github.io/bpf/blog/2020/02/19/bpf-portability-and-co-re.html 
+[co-re]: https://facebookmicrosites.github.io/bpf/blog/2020/02/19/bpf-portability-and-co-re.html
 [tokio]: https://docs.rs/tokio
 [async-std]: https://docs.rs/async-std
@ -65,7 +82,7 @@ use aya::programs::{CgroupSkb, CgroupSkbAttachType};
 // load the BPF code
 let mut bpf = Bpf::load_file("bpf.o")?;
-// get the `ingress_filter` program compiled into `bpf.o`. 
+// get the `ingress_filter` program compiled into `bpf.o`.
 let ingress: &mut CgroupSkb = bpf.program_mut("ingress_filter")?.try_into()?;
 // load the program into the kernel
@ -77,10 +94,6 @@ let cgroup = File::open("/sys/fs/cgroup/unified")?;
 ingress.attach(cgroup, CgroupSkbAttachType::Ingress)?;
 ```
 ## Community
 Join [the conversation on Discord][chat-url] to discuss anything related to aya.
 ## Contributing
 Please see the [contributing guide](https://github.com/aya-rs/aya/blob/main/CONTRIBUTING.md).
@ -89,7 +102,7 @@ Please see the [contributing guide](https://github.com/aya-rs/aya/blob/main/CONT
 Aya is distributed under the terms of either the [MIT license] or the [Apache License] (version
 2.0), at your option.
-Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. 
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 [MIT license]: https://github.com/aya-rs/aya/blob/main/LICENSE-MIT
 [Apache license]: https://github.com/aya-rs/aya/blob/main/LICENSE-APACHE