https://github.com/bwin/asar-archive
Small lib to read/write electron asar archives.
https://github.com/bwin/asar-archive
Last synced: 6 months ago
JSON representation
Small lib to read/write electron asar archives.
- Host: GitHub
- URL: https://github.com/bwin/asar-archive
- Owner: bwin
- Created: 2016-02-14T09:40:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-16T06:06:53.000Z (over 10 years ago)
- Last Synced: 2025-09-19T00:25:07.039Z (10 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# asar-archive
**Small lib to read/write electron asar archives.** (Npm module for node.js.)
[![npm version][badgeNpm]][linkNpm] ![license][badgeLicense] ![npm total downloads][badgeDownloads] [![dependencies][badgedDependencies]][linkDependencies] [![code coverage][badgeCoverage]][linkCoverage] [![build status][badgeBuild]][linkBuild]
## Table of Contents
- [Alternatives](#alternatives)
- [Motivation](#motivation)
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples](#examples)
- [Example 1](#example-1)
- [Example 2](#example-2)
- [Contributing](#contributing)
- [License](#license)
## Alternatives
- [asar-cli]: command line interface
- [grunt-asar]: grunt task
- [gulp-asar]: gulp task
- ([asar]: official command line interface and lib)
## Motivation
...
## Installation
Install with `npm install asar-archive --save`.
## Documentation
- [Module asar]: High level functions.
- [Class AsarArchive]: Lower level functions.
- [Asar file format]: Visualization of the structure of an asar archive.
## Examples
### Example 1
```
...
```
### Example 2
```
...
```
## Contributing
- In lieu of a formal styleguide, take care to maintain the existing coding style.
- The source code is written in CoffeeScript and is in `src/`. Run `npm run build` to compile to JavaScript in `lib/`.
- Add unit tests for any new or changed functionality and fixed issues.
- Test your code using `npm test`.
## License
The MIT License (MIT)
Copyright (c) 2016 Benjamin Winkler ([bwin])
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[badgeNpm]: https://img.shields.io/npm/v/asar-archive.svg?style=flat-square
[badgeLicense]: https://img.shields.io/npm/l/asar-archive.svg?style=flat-square
[badgeDownloads]: https://img.shields.io/npm/dt/asar-archive.svg?style=flat-square
[badgedDependencies]: https://img.shields.io/david/bwin/asar-archive/master.svg?style=flat-square
[badgeCoverage]: https://img.shields.io/coveralls/bwin/asar-archive/master.svg?style=flat-square
[badgeBuild]: https://img.shields.io/travis/bwin/asar-archive/master.svg?style=flat-square
[linkNpm]: https://npmjs.org/package/asar-archive
[linkDependencies]: https://david-dm.org/bwin/asar-archive/master
[linkCoverage]: https://coveralls.io/bwin/asar-archive/master
[linkBuild]: https://travis-ci.org/bwin/asar-archive/master
[bwin]: https://github.com/bwin
[asar-cli]: https://github.com/bwin/asar-cli
[grunt-asar]: https://github.com/bwin/grunt-asar
[gulp-asar]: https://github.com/bwin/gulp-asar
[asar]: https://github.com/atom/asar
[Module asar]: https://githubusercontent.com/bwin/asar-archive/master/docs/api/Asar.html
[Class AsarArchive]: https://githubusercontent.com/bwin/asar-archive/master/docs/api/AsarArchive.html
[Asar file format]: https://htmlpreview.github.io/?https://raw.githubusercontent.com/bwin/asar-archive/master/docs/asar-format.html