{"_id":"size-table","_rev":"4-8638e384c7c507059a9fddf952280b97","name":"size-table","description":"automagically display the size of your module at various levels of compression in your readme","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"size-table","version":"0.1.0","description":"automagically display the size of your module at various levels of compression in your readme","bin":{"size-table":"bin/size-table"},"dependencies":{"markdown-table":"~0.4.0","mdast":"~2.3.0","minimist":"~1.2.0","pretty-bytes":"~2.0.1","readme-filenames":"~1.0.0","sizeist":"~1.0.1"},"devDependencies":{},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git@github.com:michaelrhodes/size-table"},"keywords":["module","size","table","readme"],"author":{"name":"Michael Rhodes"},"license":"MIT","bugs":{"url":"https://github.com/michaelrhodes/size-table/issues"},"homepage":"https://github.com/michaelrhodes/size-table","gitHead":"8457fb043d366099fc56c7eae2a982756941580d","_id":"size-table@0.1.0","_shasum":"019fbef13d82c916eb18b8eb7c73c148a04b1e20","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"michaelrhodes","email":"spam@michaelrhod.es"},"maintainers":[{"name":"michaelrhodes","email":"spam@michaelrhod.es"}],"dist":{"shasum":"019fbef13d82c916eb18b8eb7c73c148a04b1e20","tarball":"https://registry.npmjs.org/size-table/-/size-table-0.1.0.tgz","integrity":"sha512-xrm7IYVSqb+PCkiBj1HwHv0kZhcFq20c/G+vaedzhKPqYfMr34rjXr2kh8WDqMgrMzLV/akZQjwP+WP1OF5+Fg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDAkDLEgvR3wpl3HPqrZq4dSe9Eyx8k/ye6B93quz7xnAIgfKO8+/jG6Z/DDHDY7LfRVxGeV4Ugti9afvc1aHPzLow="}]}},"0.2.0":{"name":"size-table","version":"0.2.0","description":"automagically display the size of your module at various levels of compression in your readme","bin":{"size-table":"bin/size-table"},"dependencies":{"markdown-table":"~0.4.0","mdast":"~2.3.0","minimist":"~1.2.0","pretty-bytes":"~2.0.1","readme-filenames":"~1.0.0","sizeist":"~1.0.1"},"devDependencies":{},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git@github.com:michaelrhodes/size-table"},"keywords":["module","size","table","readme"],"author":{"name":"Michael Rhodes"},"license":"MIT","bugs":{"url":"https://github.com/michaelrhodes/size-table/issues"},"homepage":"https://github.com/michaelrhodes/size-table","gitHead":"b202bc7f8e23a25c30c4e7dabdab6e4ddaa26a12","_id":"size-table@0.2.0","_shasum":"39ab5394e17f83473ad890b5ebaa0d471a12ae1f","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"michaelrhodes","email":"spam@michaelrhod.es"},"maintainers":[{"name":"michaelrhodes","email":"spam@michaelrhod.es"}],"dist":{"shasum":"39ab5394e17f83473ad890b5ebaa0d471a12ae1f","tarball":"https://registry.npmjs.org/size-table/-/size-table-0.2.0.tgz","integrity":"sha512-JcfL/Xip2DVeB6D5av0WsMizKbM6+TGY1RaNhQY4y5Dunxf+jzKVDZ4znpdbszWorNNngCKjaxGnCH8Whutehg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGh6xQ7kgtDMTgy1JZYnbMQJOAlutN2cYwu6MmZLH/H8AiEAg3Q7LGACngyxSxaidbBdvdTZ65YRMFWpUwm7Vdhoxko="}]}}},"readme":"# size-table\n\nAutomagically display the size of your module at various levels of compression in your README. This is probably the most opinionated module/tool I will ever write.\n\n## Install\n\n```sh\n$ npm install -g size-table\n```\n\n## Usage\n\n### Basic\n\nFrom the root of your project directory (ideally in an npm script) :\n\n```sh\n$ cat bundle.js | size-table\n```\n\nThe first time this command is run, a size table will be inserted before the first subheading. If no subheadings exist, it will be appended to the end of the README.\n\nIt looks like this:\n\n| compression          |  size |\n| :------------------- | ----: |\n| size-table.js        | 771 B |\n| size-table.min.js    | 631 B |\n| size-table.min.js.gz | 348 B |\n\n\nNote that by default, the filename will be `package.name` as found in your package.json, falling back to “bundle” if a package.json cannot be found. You can override this behaviour by providing your desired name as the first argument:\n\n```sh\n$ cat bundle.js | size-table my-module\n```\n\n| compression         |  size |\n| :------------------ | ----: |\n| my-module.js        | 746 B |\n| my-module.min.js    | 606 B |\n| my-module.min.js.gz | 328 B |\n\nNote that all subsequent invocations of the command will update the existing table. Additionally, once created, you are free to move the table to any location in your README.\n\n### Advanced (sort of, but not really)\n\nsize-table should be able to find your README and packge.json files if they exists in the working directory. If it can’t, you can specify correct directory to search like so:\n\n```sh\n$ cat bundle.js | size-table --cwd=../elsewhere\n```\n\nFinally, if you don’t want size-table to overwrite your README file, you can have the mutated document sent directly to stdout by using the following flag:\n\n```sh\n$ cat bundle.js | size-table --stdout\n```\n\n## Licence\n\n[MIT](http://opensource.org/licenses/MIT)\n","maintainers":[{"name":"michaelrhodes","email":"spam@michaelrhod.es"}],"time":{"modified":"2022-06-26T20:26:48.867Z","created":"2015-12-13T04:30:30.269Z","0.1.0":"2015-12-13T04:30:30.269Z","0.2.0":"2015-12-13T05:16:00.130Z"},"homepage":"https://github.com/michaelrhodes/size-table","keywords":["module","size","table","readme"],"repository":{"type":"git","url":"git@github.com:michaelrhodes/size-table"},"author":{"name":"Michael Rhodes"},"bugs":{"url":"https://github.com/michaelrhodes/size-table/issues"},"license":"MIT","readmeFilename":"readme.md"}