Skip to content

Commit

Permalink
update readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
JSHan94 committed May 8, 2024
1 parent 69d96f2 commit 847c333
Show file tree
Hide file tree
Showing 3 changed files with 144 additions and 10 deletions.
109 changes: 109 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
Business Source License 1.1

License text copyright © 2023 MariaDB plc, All Rights Reserved.
“Business Source License” is a trademark of MariaDB plc.

-----------------------------------------------------------------------------

Parameters

Licensor: Initia Foundation

Licensed Work: Initia
The Licensed Work is (c) 2023 Initia Foundation

Additional Use Grant: None

Change Date: 2028-01-01

Change License: GNU Lesser General Public License v3.0 or later

For information about alternative licensing arrangements for the Software,
please visit: https://mariadb.com/products/mariadb-enterprise

-----------------------------------------------------------------------------

Terms

The Licensor hereby grants you the right to copy, modify, create derivative
works, redistribute, and make non-production use of the Licensed Work. The
Licensor may make an Additional Use Grant, above, permitting limited
production use.

Effective on the Change Date, or the fourth anniversary of the first publicly
available distribution of a specific version of the Licensed Work under this
License, whichever comes first, the Licensor hereby grants you rights under
the terms of the Change License, and the rights granted in the paragraph
above terminate.

If your use of the Licensed Work does not comply with the requirements
currently in effect as described in this License, you must purchase a
commercial license from the Licensor, its affiliated entities, or authorized
resellers, or you must refrain from using the Licensed Work.

All copies of the original and modified Licensed Work, and derivative works
of the Licensed Work, are subject to this License. This License applies
separately for each version of the Licensed Work and the Change Date may vary
for each version of the Licensed Work released by Licensor.

You must conspicuously display this License on each original or modified copy
of the Licensed Work. If you receive the Licensed Work in original or
modified form from a third party, the terms and conditions set forth in this
License apply to your use of that work.

Any use of the Licensed Work in violation of this License will automatically
terminate your rights under this License for the current and all other
versions of the Licensed Work.

This License does not grant you any right in any trademark or logo of
Licensor or its affiliates (provided that you may use a trademark or logo of
Licensor as expressly required by this License).

TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
TITLE.

MariaDB hereby grants you permission to use this License’s text to license
your works, and to refer to it using the trademark “Business Source License”,
as long as you comply with the Covenants of Licensor below.

-----------------------------------------------------------------------------

Covenants of Licensor

In consideration of the right to use this License’s text and the “Business
Source License” name and trademark, Licensor covenants to MariaDB, and to all
other recipients of the licensed work to be provided by Licensor:

1. To specify as the Change License the GPL Version 2.0 or any later version,
or a license that is compatible with GPL Version 2.0 or a later version,
where “compatible” means that software provided under the Change License can
be included in a program with software provided under GPL Version 2.0 or a
later version. Licensor may specify additional Change Licenses without
limitation.

2. To either: (a) specify an additional grant of rights to use that does not
impose any additional restriction on the right granted in this License, as
the Additional Use Grant; or (b) insert the text “None”.

3. To specify a Change Date.

4. Not to modify this License in any other way.

-----------------------------------------------------------------------------

Notice

The Business Source License (this document, or the “License”) is not an Open
Source license. However, the Licensed Work will eventually be made available
under an Open Source License, as stated in this License.

For more information on the use of the Business Source License for MariaDB
products, please visit the MariaDB Business Source License FAQ at
https://mariadb.com/bsl-faq-mariadb.

For more information on the use of the Business Source License generally,
please visit the Adopting and Developing Business Source License FAQ at
https://mariadb.com/bsl-faq-adopting.
19 changes: 19 additions & 0 deletions LICENSE.header
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
SPDX-License-Identifier: BUSL-1.1

Copyright (C) 2023, Initia Foundation. All rights reserved.
Use of this software is govered by the Business Source License included
in the LICENSE file of this repository and at www.mariadb.com/bsl11.

ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
VERSIONS OF THE LICENSED WORK.

THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).

TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
TITLE.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,25 @@ import { MoveBuilder } from '@initia/builder.js';
async function buildExample() {
// recommend to use full package path, not relative path
// ex) path.resolve(__dirname, "../relative_path")
const builder = new MoveBuilder(/* path to move package */, {});
const builder = new MoveBuilder(
path.resolve(__dirname, 'moon_coin'), // move package path
{} // build options
);

// execute move compiler via ffi
await builder.build();

// load compiled module bytes as `Buffer`
const compiledModuleBytes = await builder.get(/* module name */);
const compiledModuleBytes = await builder.get(
'moon_coin' // module name
);
console.info(compiledModuleBytes.toString('hex'));

// change module name to what you want
const nameConvertedModuleBytes = await MoveBuilder.convert_module_name(compiledModuleBytes, /* new module name */);
const nameConvertedModuleBytes = await MoveBuilder.convert_module_name(
compiledModuleBytes, // compiled module bytes
'sun_coin' // new module name
);
console.info(nameConvertedModuleBytes.toString('hex'));
}

Expand All @@ -40,12 +48,10 @@ async function buildExample() {
import { MoveBuilder } from '@initia/builder.js';

async function createAndCleanExample() {
// recommend to use full package path, not relative path
// ex) path.resolve(__dirname, "../relative_path")
const builder = new MoveBuilder(/* path to move package */, {});

const builder = new MoveBuilder(path.resolve(__dirname, 'moon_coin'), {});

// create new move package
await builder.new(/* package name */);
await builder.new('new'/* package name */);

await builder.build();

Expand All @@ -60,9 +66,9 @@ async function createAndCleanExample() {
import { MoveBuilder } from '@initia/builder.js';

async function readExample() {
const builder = new MoveBuilder(/* path to move package */, {});
const builder = new MoveBuilder(path.resolve(__dirname, 'moon_coin'), {});

const binary = await builder.get(/* module name */);
const binary = await builder.get('moon_coin');

// read module bytes
const moduleInfo = await MoveBuilder.read_module_info(binary)
Expand Down

0 comments on commit 847c333

Please sign in to comment.