import-string - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "import-string",
   "author": "David Arenas <[e-mail]> (https://github.com/Dave136)",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
@@ -6,0 +6,0 @@ "main": "./dist/index.cjs",

README.md

@@ -1,15 +0,71 @@
-# transform-component
+# import-string
 
-To install dependencies:
+This package allow us to import code from simple string, with support to:
 
+- [node](https://nodejs.org)
+- [deno](https://deno.land)
+- [bun](https://bun.sh)
+
+### Getting started
+
+This is a lightweight and simple package, you can install it using your favorite node package manager:
+
 ```bash
-bun install
+npm i import-string
 ```
 
-To run:
+```bash
+pnpm add import-string
+```
 
 ```bash
-bun run index.ts
+yarn add import-string
 ```
 
-This project was created using `bun init` in bun v1.0.3. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+```bash
+bun aa import-string
+```
+
+### Usage
+
+In your file you can declare the module, functionality or variable in a string like the following example:
+
+```typescript
+const stringSrc = `export const example = (): string => {
+  return {
+    foo: 'baz'
+  }
+}`;
+```
+
+From the package you can import the `importModule` function that receive string and returns the module:
+
+```typescript
+import { importModule } from 'import-string';
+
+async function main() {
+  const mod = await importModule(stringSrc);
+
+  console.log(mod.example().foo); // output -> baz
+}
+```
+
+### Development
+
+1. Clone this repository
+2. Install dependencies using `pnpm install`
+
+Send a PR with the `feat|fix|refactor` etc
+
+### Support
+
+- BTC: `1Bwo1Htd47rLRM4PZhydWtoC5ZAR4Fv9KZ`
+- USDT: [binance-qr](https://github.com/Dave136/vue-email/blob/main/docs/public/binance-qr.png?raw=true)
+
+### Author
+
+[David Arenas](https://github.com/Dave136)
+
+### License
+
+This project is licensed under [MIT](./LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5353

increased by27.09%

Number of lines in readme file

72

increased by350%

No dependency changes