Library to use and export USFM zip files.
View Demo and examples
·
Report Bug
·
Request Feature
Table of Contents
Purpose
- Create functionality to open usfm zip files, edit them, and export them to a zip file.
Scope
- The goal of this library is to provide helper functions to open and export zipped usfm files. UI/UX design is minimal as to be kept reusable by in whatever user interface this functionality is used in.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
If you wish to use this library in your app you will need to add it as a dependency with:
npm install zip-project
OR
yarn add zip-project
Also you will need to add the peer dependencies:
npm install @mui/material @mui/styles @mui/icons-material @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl
OR
yarn add @mui/material @mui/styles @mui/icons-material @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl
See Styleguidist link for many usage examples.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.
You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
If you would like to fork the repo and create a pull request.
-
Fork the Project
-
Clone the repo
git clone https://github.com/kintsoogi/zip-project.git
-
Install NPM packages
yarn
-
Create your Feature Branch (
git checkout -b feature/AmazingFeature
) -
Commit your Changes (
git commit -m 'Add some AmazingFeature'
) -
Push to the Branch (
git push origin feature/AmazingFeature
) -
Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.