Samurai

Build Firefox-based browsers with ease

This is still in a prerelease / prototype phase. Changes will be made, things will be broken Fork of the gluon project

Installation

Per project (recommended):

npm install @praxive/samurai
# or
yarn add @praxive/samurai

Globally:

npm install -g @praxive/samurai
# or
yarn global add @praxive/samurai

# Note: Linux and mac users may have to run the above command with sudo

Documentation

Documentation is available on praxivesoftware.github.io/samurai or in the docs folder of this repository.

Licencing notes

The following is included in good faith. The writer is not a lawyer, and this is not legal advice.

Gluon

Samurai is a fork of Gluon, which is licensed under MPL v2.0. The original license is included in the LICENSE file.

Melon

Gluon has been extracted from melon, the build tool for the desktop version of Dot Browser under MPL v2.0.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Firefox

This program downloads and modifies Firefox. Follow their license when distributing your program.

Logo

The package icon is from Microsoft's Fluent Emoji. There is an ongoing conversation regarding the license.

MIT License

Copyright (c) Microsoft Corporation.

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.