dastine/README.md

A middleware for cryptography tasks

# 🛡️ Dastine

**Dastine** is a secure, client-side middleware library for handling cryptographic tasks in web applications.

---

## 📦 Installation

Install via npm:

```bash
npm install dastine
```

---

## 🚀 Usage Example (React)

Here's a sample React component that checks for the Dastine middleware and retrieves its version:

```jsx
import { useState,useEffect } from 'react'
import './App.css'
import dastine from 'dastine'



function App() {

  const [version, setVersion] = useState("");

  useEffect(() => {
    if(dastine.isInstalled === true){
      dastine.GetVersion(function(event) {
      var ver = event.data.Result;
        setVersion(ver);					
      }); 
    }
  }, [dastine.isInstalled]);

  return (
    <>
      <h1>Dastine</h1>
      <div className="card">
        <p>
          dastine version {version} is installed on your system
        </p>
      </div>
      <p className="read-the-docs">
        visit pki.co.ir for more information
      </p>
    </>
  )
}

export default App

```

---

## 🧠 About the Project

- **Organization**: [Pendar Kooshk Imen](https://pki.co.ir)  
- **Official Website**: [https://pki.co.ir](https://pki.co.ir)  
- **Author**: M.Dabaghian@pki.co.ir  

---

## 📎 Requirements

- Dastine must be installed and running on the client machine
- Supported in all browsers (Chrome, Edge, Firefox)

---

## 🛠 Development

This package is written in JavaScript and exported as a CommonJS module. TypeScript projects may require a manual declaration file if you haven't included one yet.

To add type support in consumer projects:

```ts
// src/types/dastine.d.ts
declare module 'dastine';
```

---

## 📄 License

This project is proprietary software developed by **Pendar Kooshk Imen**.  
All rights reserved.

---

## 🌐 Support

For questions, technical support, or licensing, please visit:

🔗 [https://dastine.pki.co.ir/doxygen/index.html]
📧 support@pki.co.ir